Guides

Authentication

Suggest Edits

Welcome to the Dexatel API authentication documentation. This guide is designed to provide developers with the information required to securely authenticate with the Dexatel API, ensuring that your applications can safely communicate with Dexatel's services. Our authentication system is built to protect your data and offer seamless integration.

Authentication Methods

Dexatel API uses API Keys to authenticate requests. Each request to our API endpoints must include a valid API Key, which associates API requests with your account.

API Key

Obtaining Your API Key

  1. Sign in to your Dexatel Dashboard.
  2. Navigate to the APIs section on the left-hand side navigation menu.
  3. Under the API Keys tab, click on the Create a Key button and follow the instructions.
  4. Copy and save your new API Key. Keep it secure; it's your private key to access the API.

Using Your API Key

Include your API Key in the header of every request you make to the Dexatel API:

X-Dexatel-Key: YOUR_API_KEY

Replace YOUR_API_KEY_HERE with your actual API Key.

Making Authenticated Requests

To make an authenticated request to the Dexatel API, include your API Key in the request header. Here's an example using curl:

curl -X GET "https://api.dexatel.com/v1/resource" \
     -H "X-Dexatel-Key: YOUR_API_KEY"

Best Practices for Secure API Use

  • Keep your API Key secret. Do not share your API Key in publicly accessible areas such GitHub, client-side code, and so forth.
  • Limit access. Only use your API Key in necessary applications and services.
  • Monitor activity. Regularly check your API usage for unexpected or unauthorized activity.
  • Regenerate keys. If you suspect your API Key has been compromised, regenerate it immediately from your Dexatel Dashboard.

Handling Errors

Dexatel API uses standard HTTP status codes to indicate the success or failure of an API request. For authentication-related errors, you might encounter:

  • 401 Unauthorized - The API Key is missing or invalid.
  • 403 Forbidden - The API Key does not have permission to perform the requested operation.

Ensure your API Key is correctly included in the request header and that it is valid.

Support

If you encounter any issues with authentication or have any questions, please contact our support team at [email protected]. We're here to help.

Updated 8 months ago