Kickstart your journey with our platform using the FAQ for quick answers and the User Guide for detailed tips!
What is the difference between an API and an API Product?
API (Application Programming Interface): A set of protocols that allow software applications to communicate with each other.
API Product: A packaged set of APIs bundled together to provide specific functionalities, often with defined access levels and usage limits.
What is the difference between the UAT URL and a live URL?
The main difference between a UAT URL and a live URL is:
UAT URL: Used for testing in a pre-production environment where developers and business users can validate functionality before going live.
Live URL: Used in the production environment where real users interact with the application.
Where do I go to request API keys?
To authenticate your app and gain access to the CAIT APIs, follow these steps:
Log in to your developer account on the CAIT API developer portal.
Click on "My Apps" in the main menu.
On the My Apps page, click "Create App."
Provide a unique name for your app and select the API products you want to use.
Click "Create App" to generate the consumer key and secret, which are required for authentication and token generation.
I’m not getting the expected response. Who do I contact?
If you’re not receiving the expected response, consider troubleshooting first by:
Checking your internet connection
Clearing your cache and cookies
Trying a different browser or device If the issue persists, contact the CAIT support team for further assistance.
How do I troubleshoot if my JWT is not working?
If your JWT authentication is failing, try the following:
Verify the token format and signature.
Ensure the token has not expired.
Check the secret key or public key used for signing.
Decode the token using a JWT debugger to inspect its payload.
Confirm that the correct authorization header is used in API requests.
How does JWT authentication work?
JWT authentication follows these steps:
A client sends a login request with credentials to the authentication server.
The server validates the credentials and generates a JWT.
The client uses the JWT in subsequent API requests as a bearer token in the authorization header.
The server verifies the JWT signature and processes the request if valid.
What is JWT (JSON Web Token)?
JWT (JSON Web Token) is a compact, URL-safe token format used for securely transmitting information between parties as a JSON object. It is commonly used for authentication and authorization in APIs. JWTs are signed using a secret key or a public/private key pair to ensure integrity and authenticity.
What is OAuth?
OAuth (Open Authorization) is a widely used protocol for authorization. It allows users to grant third-party applications access to their resources without sharing login credentials. OAuth uses tokens and redirects to authenticate and authorize users, granting access to required resources securely.
What are the key steps to creating an app in a developer portal?
The key steps to creating an app in a developer portal include:
Creating a developer account
Obtaining API credentials
Defining the app’s purpose
Configuring the app’s settings
Integrating the app with the API
Testing and debugging the app
Promoting the app
Why is a UAT environment important for developers?
A UAT (User Acceptance Testing) environment is crucial for developers as it allows them to test and validate an API or application in a controlled environment before deploying it to production. It provides a safe space to refine and debug code while ensuring it meets business requirements.
