Authentication

You'll need to authenticate your requests to access any of the endpoints in the API. In this guide, we'll look at how authentication works. We offers a simple authentication system for your API requests.

API Key authentication

With API Key authentication, you use your API key to authenticate your HTTP requests. Here's how to authenticate using cURL:

Example request with API Key auth

curl --header "Api-Key: $YOUR_API_KEY" \
    "https://api.synaps.io/v4/session/init"

Please don't commit your API Key to GitHub!