This guide provides an overview of the authentication process on our platform. To learn more about API usage, please visit our API Documentation.
Overview
Authentication is a crucial aspect of our platform's security. It ensures that only authorized users can access sensitive information and perform actions.
Steps for Authentication
- Register an Account: To get started, you need to register an account on our platform.
- Generate an API Key: Once your account is registered, generate an API key from your profile settings.
- Use API Key for Authentication: When making requests to our API, include the API key in the request header for authentication.
API Key Format
The API key format is Bearer <API_KEY>. For example:
Authorization: Bearer 12345abcde
API Endpoints
We offer various API endpoints for authentication purposes. Below are some commonly used endpoints:
/en/api-docs/auth-guide- This guide (you are here!)/en/api-docs/auth/register- Register a new account/en/api-docs/auth/login- Login to an existing account/en/api-docs/auth/logout- Logout from an account
Security Best Practices
- Keep Your API Key Secret: Never share your API key with others.
- Regularly Rotate Your API Key: To enhance security, we recommend rotating your API key periodically.
- Use HTTPS: Always use HTTPS for secure communication with our API.