Welcome to the Scudo API documentation! This guide will walk you through the process of getting started with the Scudo API, including authentication, API endpoints, and best practices.
The Scudo API follows a REST architecture, which includes endpoints for accessing resources of the company, such as profile, team, products, clients, subscriptions, claims, and more.
You can access each endpoint by specifying the desired resource through a URL and selecting the appropriate HTTP method (GET, POST, PATCH, DELETE).
Additionally, each endpoint returns responses in a JSON format. The response may or may not include data depending on the operation but will always include a message.
{
"status_code": ...,
"message": "...",
"data": ...
}
To access the Scudo API endpoints, you will need to authenticate your requests using an API key. Include the API key as a request header value of key api-access-key.
For optimal use of the Scudo API, we suggest adhering to the following best practices:
- Use the appropriate HTTP method for each request.
- Ensure that all required parameters are included in your requests.
- Handle errors gracefully by checking the HTTP response code and message.
By following these practices, you can help ensure that your requests are processed correctly and that any issues are handled effectively. This will help you get the most out of the Scudo API and enable a smoother integration.