Introduction
Our APIs help your business quickly turn data into insights that drive financial outcomes. Create loyal customers, drive revenue growth and arm your teams with the knowledge they need to succeed.
CloudLink offers over 300 Reporting APIs, providing you the flexibility to scale and integrate CloudLink applications with your business and products.
Our powerful Integration APIs allow you to write data between CloudLink and other applications, enabling you to accelerate value from your ecosystem of products.
Purpose of this Document
This document will go through all steps needed to acquire and apply API Keys, a required element to use for all CloudLink APIs. This document will provide the available API URLs per environment. Lastly, this document will also walk through the use of Postman as an API visualization tool. By the end of this document you should be able to authenticate your API calls and be able to call any reporting API through Postman.
API Keys
In order to begin using CloudLink APIs, you must get the API Keys.
Texada provides 2 different API Keys, one for each environment (Sandbox & Production).
Your API Key must be included in the header of all API requests. Insert your Key into a header variable called “x-api-key”.
To obtain your API Keys, please coordinate with any of our Product Consultants who will work with you to relay your keys in a safe manner.
API URLs
In order to begin using CloudLink APIs, you must be using the proper region and environment URL.
USEast Region:
- Production: use-api.cloudlink.texadasoftware.com/v1/{tenant}/{API_NAME}
- Sandbox: use-api.sandbox-cloudlink.texadasoftware.com/v1/{tenant}/{API_NAME}
Australia Region:
- Production: au-api.cloudlink.texadasoftware.com/v1/{tenant}/{API_NAME}
- Sandbox: au-api.sandbox-cloudlink.texadasoftware.com/v1/{tenant}/{API_NAME}
{tenant} is a placeholder that needs to be replaced by a lowercase tenant name which is located in the URLs for any CloudLink application.
Example: https://use.cloudlink.texadasoftware.com/demo/CustomerSearch/ where demo in this case is the tenant name.
API Authentication
Before calling any CloudLink API, by passing the API Key to the authentication API /auth, you will receive a valid access token. This token must be used in all API calls till it expires.
Your access Token must be included in the header of all API requests. Insert your access into a header variable called “Authorization”.
The value of this header variable needs to be “Bearer” + “ “ + {access token}. For example, if your access token is “abc123” then the header variable’s value needs to be “Bearer abc123.”
Your First API Call
Once you have your API Key you are ready to begin using CloudLink APIs. This next step-by-step guide will show you how to set up CloudLink APIs in Postman, an API visualization tool.
1. Download and install Postman from https://www.getpostman.com/downloads/.
2. Import these 3 files into Postman:
-
- CloudLinkAPI.postman_collection.json
- Sandbox.postman_environment.json
- Production.postman_environment.json
The “CloudLinkAPI” file is called “collection” in Postman. It is a subset list of CloudLink APIs and you can add more to it as needed. The “environment” files specify user-specific settings which will need to be set like APIKey.
3. Select the sandbox environment from the drop-down at the top right of your workspace page.
If you are early on in the onboarding process, your production environment won’t be set up yet.
5. Change the settings by editing the Current Value column:
-
- x-api-key: API key you generated from the Dev Portal.
- tenant: The lowercase tenant name which is located in the URLs for any CloudLink application.
- Example: https://use.cloudlink.texadasoftware.com/demo/CustomerSearch/ where demo in this case is the tenant name.
6. Click on the request called “POST auth” on the left. This will be used to get a valid access Token.
7. Click the [Send] button. If the call was successful, a status of “200 OK” will be displayed as well as a long access token. Go to Step 8.
When you press [Send] on the “auth” API, you are essentially logging in and starting a session. The session will last for some time before expiring at which point you will need to click [Send] on the “auth” request again to continue using APIs.
Behind the scenes, there is a “test” which is performed after the “auth” request finishes successfully that updates the environment setting called “authorization,” which is passed in the header of all other API requests (along with the API key and tenant name).
If the call was unsuccessful, troubleshoot the problem using the error that was returned.
Troubleshooting
- Invalid API Key: Make sure you are using the correct API key for the targeted environment.
- Other Error: Make sure the “tenant” environment setting is right. If after trying that and the error still persists, contact Texada customer service at cloudlinksupport@texadasoftware.com.
If the call was successful but no data is displayed, then there is currently no data in that API, as shown below:
