Ultimate makes a server to server HTTP request to your backend system.
|
ℹ️ Note: If your API has different requirements, please reach out to your Ultimate contact to discuss. |
Technical Requirements of your backend API
API types
Your API must be one of the following:
- REST APIs
- GraphQL
Response:
Your API response must follow the general requirements:
- Provide an API response within 9 seconds
- Preferably JSON format
Authentication
From the Ultimate side, we can authenticate using any of the following:
- JWT
- API key or token based
- basic authentication
- Oauth2
- IP safelists/allowlist
Self checklist
The self checklist below contains questions and information that will help you build a robust API:
-
Is the API "searchable" with data that a typical user has?
- Does the data in the API response contain information that a typical user is looking for?
-
Is it known when the API throws a 200, a 400, and a 404 HTTP status code?
-
What does the API return if the input is invalid or incorrect?
-
Documentation - API request and response schema
-
Test data for the most common use cases
-
Your API rate limit
Read more about the onboarding plan in the previous article, Custom integration - preparation.