Kaizala API Documentation
Before you get started, please refer to Setup for using the Kaizala Connectors
Root Domain
The root domain for invoking the Kaizala APIs is:
{endpoint-url}
| Parameter | Type | Optional? | Description | |
|---|---|---|---|---|
| Endpoint url | endpoint-url |
String | No | On successful auth while generating access tokens, an endpoint url is returned that should be used as api-base-url for making subsequent API calls |
While hitting any Kaizala api, you can get Http status code:308 indicating that the user's endpoint-url has changed. In that case, Response header location will contain the new endpoint-url.
Suggestion: Clients can configure timeout to receive response from Kaizala APIs at 1 min
API End-points
The Kaizala API runs on the secure Microsoft Azure cloud, and interacts with the Kaizala platform to perform various actions for end users. The API works with the following Kaizala resources:
Kaizala API has throttling limits of
- 100 calls per min per connector
- 300 calls per min per tenant (across connectors)
When throttling limit exceeds, the API will return "Retry-After" value along with Http status code:429. The "Retry-After" value specifies how many seconds to wait before making another request.
WebHooks
The Microsoft Kaizala API also provides a way for developers to register for specific events within the Kaizala platform via WebHooks.
Postman Collection
In order to test our APIs, as well as understand Kaizala API schema, you can import postman collection containing samples and schema for all the Microsoft Kaizala apis:
Please set following environment variables in "Kaizala-APIs-environment" before running the postman project:
- mobile-number : Your mobile number which will be used for invoking apis
- application-id : ID associated with the Connector
- application-secret : Secret associated with the Connector
Other environment variables will be auto-populated while trying the apis in sequence mention in Postman Project.