Authentication

i-payout's API employs an ApiKey security schema to authenticate HTTP requests. These keys are access credentials composed of alphanumeric characters. Think of them as digital "keys" that open the door to specific API endpoints, ensuring that only authorized users or systems can request and retrieve data.

This security schema provides a secure and efficient way to access and utilize data, services, or resources offered by our application programming interface (API). To use it, you will need to include an authorization header, adding Bearer <YOUR_API_KEY> as its value. The following code snippet shows an example of a request, including the authentication headers:

curl --request <Method> \
     --url <URL> \
     --header 'authorization: <YOUR_API_KEY>' \
     --header 'accept: application/json'

🚧

Keep your keys safe

It is important to avoid sharing your secret API keys in public places like Github or Bitbucket since it can allow malicious API calls.

How to Generate Your Token

i-payout offers you two different tokens, and each has a different way of being generated: