Skip to main content

Authentication & Authorization​

The Whalemate API uses API Keys based authentication to ensure secure access to resources. Here you will learn how to generate, use and protect your credentials.

📌 Generate​

To use the API, you first need to obtain an API Key from your account:

  1. Log in to Whalemate App.
  2. Go to Settings > Integrations and scroll down to Api Keys.
  3. In the Active Keys table you will have the possibility to create a new key, assigning it a description.
Note
API Keys must be kept secret, so you will only be able to see the full API Key only when you create it. If you suspect that your API Key has been compromised, revoke it and generate a new one.

🚀 Consume​

Each API request must include the API Key in the headers for authentication.

  • curl
  • JavaScript
bash curl -H "X-API-KEY: YOUR_API_KEY" https://back.whalemate.com/endpoint
Last updated on