Authentication

You'll need to authenticate your requests to access any of the endpoints in the Caruuto API. In this guide, we'll look at how authentication works. Caruuto API requests are authenticated using API keys, which can be found in your project settings.

API key authentication

Currently, the only way to authenticate with the Caruuto API is by including an API key in an Authorization header. When establishing a connection, you will need your API key — you will find it in the project settings under API Keys. Here's how to add the API key to the request header using cURL:

curl https://caruuto.com/api/v1/posts \
  -H "Authorization: Api-Key-v1 {apiKey}"

Always keep your API key safe and reset it if you suspect it has been compromised.

Using an SDK

If you use one of our official SDKs, you won't have to include the Authorization header to each request manually - fetch your API key from the project settings screen, and instantiate the client library with it. The Authorization header will be included with every request made using the client library.