Striven Integrations
API Settings
Guide
-
Overview
API stands for Application Programming Interface. An API is a software “messenger” that allows two applications to communicate with each other by taking requests and telling other systems what you want to do and returning the response.
With Striven, you can enable our APIs to connect with outside sources to interconnect data, ranging from reports to accounting. By clicking Enable API Access on the API Settings page, you will receive your Client ID and Client Secret. You will also be able to assign an Employee as the Resource Owner, which is the Employee who will be notified and responsible for the API access.
- Note: User Role permissions will need to be set in Striven to allow for API access and use.
To view your API Settings in Striven, navigate to Company → Settings → Integrations → API Settings.
Example of the API Settings Page in Striven
For more detailed information regarding Striven APIs, please visit our Striven API Reference Page.
-
Threshold Notifications for API Usage Limits
On the API Settings page in your Striven system, you will notice there are Daily Usage Limit Exceeded Notifications that can be sent to a selected recipient when the usage limit is exceeded for the day. Additionally, there is an option to send a similar notification when a designated API usage threshold is reached. This threshold can be set anywhere between 1% to 99%.
Example of the Threshold Notification Settings on the API Settings Page
-
Multiple API Keys
Your Striven subscription includes access to one (1) API Key, which is limited to the API usage limits associated with your subscription plan (i.e. Standard or Enterprise). You have the option to add supplementary API Keys to your subscription for additional fees, which will provide the ability to scale up your usage limits.
Once you have enabled and configured your API Access in Striven, the API Settings page in Striven will list the available API Keys associated with your subscription, along with related details, such as Resource Owner, Subscription fee, and a link to the API Key Call Log.
- Note: If you have not subscribed to any additional API Keys, the list will only display your default API Key included with your Striven subscription.
Click the blue Plus (+) button at the top of the page to add and configure an additional API Key.
Example of Add API Key Button on API Settings Page
The Add API Key page will list the start date of the new API Key subscription. It will also indicate the prorated amount of the first invoice based on where the subscriber is in their billing cycle.
- Note: Threshold notification Settings are available on all API Keys settings and can be configured in the same way for each of them to track and maintain usage limits.
Example of the Add API Key Settings and Subscription Details
After you Save the new API Key, it will display in the list with your default API Key details. If you wish to view the API Key Info, click on the name of the API Key.
Under the Subscription column on the API Settings List, you will see the fee associated with adding the additional API Key to your subscription. This fee is based on whether you have a Standard or Enterprise Subscription.
Example of the API Settings Page Showing the Subscription Details of an Additional Key
Your API Key subscription information will also be displayed along with the rest of your subscription details. You can view this information from the Employee Actions menu in the top right corner of the window, then click on Subscription.
Example of the Subscription Option in the Employee Actions Menu
The subscription fees for additional API Keys are as follows:
- Standard Plan: Fee of $199.00 per additional key for the monthly subscription
- Enterprise Plan: Fee of $399.00 per additional key for the monthly subscription
Your subscription details can be found by clicking on the View Current Usage and Total link on the Subscription page. This will display a popup showing all of your Striven subscription information, including your Current Monthly Subscription details for additional API Keys.
Example of a Striven Subscription Page with API Key Subscription Details
Deactivating API Keys
Any API Key can be deactivated by clicking on the Trashcan icon next to the API Key name on the API Settings page. Keep in mind that deactivating the Default Key that is included in your Striven subscription will deactivate ALL of your API Keys.
- Note: API Keys cannot be reactivated once they are made inactive.
-
API Call Log Report
Striven has an API Call Log Report that will allow you to view details about your recent API usage. You can locate this report by navigating to Reports → Communications → API Call Log or by clicking on the Call Log button located on the API Settings page in Striven.
Example of How to Access the API Call Log Report in Striven
There are two (2) User Role permissions associated with access to this report:
- “API Call Log Report – View”
- “API Call Log Report – Export”
Example of the User Role Permissions Related to the API Call Log Report
Important Note: The permission to View the API Call Log Report is a very HIGH level permission because it exposes the Custom Report URIs, which effectively gives access to the data contained in the report.
This report displays a variety of information related to all calls made to the Striven API within the last 30 days. The following information is provided in columns of this report:
- Request URI: Where the request is being made (i.e. the source of the information being requested).
- Method: GET, POST, PATCH, or DELETE.
- IP Address: The address from which the call was made.
- Owner: Either the resource owner selected on the API Settings page, or in the case of Custom Reports, it will be the report owner.
- API Key Name: Identifies which API Key was used to make the call.
- Report Name: Name of the Custom Report used in the call, if applicable.
- Data Set Name: Name of the Data Set used to create the Custom Report.
- # of Calls: Lists the number of calls for that particular Request URI. This also hyperlinks to a Breakdown page with further details about each call. The Breakdown details are also exportable.
- Last Called: Displays the last date/time a call was made to that particular Request URI.
By default, the report is sorted by Last Called, but you can choose to sort by Request URI, Method, Owner, or # of Calls, if desired.
Next to the Sort options you’ll find the Export button to download the report.
Example of the Columns Available on the API Call Log Report
At the top right corner of the page, you will also find a Search icon. This will provide the following search filters:
- Date Range
- IP Address
- Request URI
- Request Method
- Owner
- Report Name
- API Key Name
Example of the Available Search Filters for the API Call Log Report
At the bottom of the page you will find the option to save your search filters for use in the future.