Requirements
Getting connected to the Whispli API requires the following:
- A subscription to Whispli which includes the API addon
- Separately purchasing the API addon
- Have access to a secure method of key exchange (such as keybase).
- Involvement from your IT and networking teams
With APIs, you can connect your Whispli platform to a Business Intelligence tool in order to create complex graphs and charts with data from other platforms. The Whispli API allows you to pull information that's collected in Whispli and push them out to a 3rd party application or directly download the data to a different source/format.
Connecting to the API
Here is a step by step breakdown of the API
1. You must first request the API authorisation token from the support team. To do this you must fit the above requirements and then send your request via email to support@whispli.com. The support team will then confirm your request. We'll then organise for the key to be provided through an appropriate and secure method.
2. Now that you have your key you can start pulling the data into the system or format required. You'll need to access the below information regarding the endpoints available.
https://app.swaggerhub.com/apis-docs/whispli/whispli-api-tenant/2
In summary, the information available as endpoints is currently the same information you are able to get through the manual data export that administrators have access to.
3. Since you now have the authorisation token and a list of available endpoints, you should be able to pull the data in the available. Currently, you're only able to request information 5 times per minute to ensure requests are resolved as efficiently as possible.
For any questions or concerns please contact support@whispli.com or your dedicated customer success manager.