¶ TELCOware Client API Documentation
The Client API is a powerful tool that allows users to interact with our system programmatically, enabling seamless integration and automation of various processes. This documentation aims to provide a comprehensive guide on how to effectively use the Client API and outlines the necessary steps to get started.
¶ Setup
¶ Enabling the Client API
Before utilizing the Client API, users are required to inform the support team about their intention to use the API. This step ensures that the Client API is enabled on the respective account and allows for the generation of the main token, which serves as a crucial authentication mechanism.
¶ Generating the Main Token
Once the support team enables the Client API, the main token is generated automatically. To access the main token, users can navigate to the Account Settings section of our My Account application. Within the Account Settings, locate the Client API tab, which is illustrated in the picture below.
¶ Client API Tab
Within the Client API tab, the following fields are available for configuration:
- Main Token:
The main token is pre-generated and exclusively visible to the account that has the Client API enabled. Changing the main token requires contacting our support team directly. The main token is primarily utilized to regenerate the client token. - Client Token:
The client token is generated using the main token and can be regenerated by users from the User Interface (UI) and also using the endpoint for refreshing Client Token. This token serves as the authorization mechanism for making API requests. It is essential for users to safeguard the client token and use it securely during API interactions. - Allowed IP Addresses:
In this text field, users can specify the IP addresses that are permitted to make requests to our API. The allowed IP addresses should be added in the following format: address, address, address, as illustrated in the picture below. This step ensures that only authorized sources can access and utilize the Client API.
¶ API Requests
With the main token and client token generated, users can now proceed to make API requests. The client token should be included in the authorization headers of each API request to ensure successful authentication and access. Refer to our Client API Documentation for detailed information regarding the available endpoints, request formats, and response structures.
¶ Protocol
Account API works by sending and receiving either POST or GET requests via HTTP protocol.
¶ Authentication
For authentication purposes, you need to get a unique Refresh Token. Refresh Token is used to get your Access Token. Refresh Token and Access Token, by default, is not set. You must ask the service provider to enable and generate Refresh Token.
¶ Important
You must make sure Refresh Token is kept secret.
¶ Requests
Both the API key and all other necessary arguments are sent as part of the HTTP GET or HTTP POST request.
Please Note:
Parameter names are case-sensitive.
¶ Responses
Response from the above sample request, by default, comes in JSON format.
¶ Documentation
¶ Additional Support
Should you encounter any issues or have further questions regarding the Client API, our support team is readily available to assist you. Feel free to reach out to us via the designated support channels, and we will be more than happy to provide the necessary guidance and assistance.