Getting started

Authentication

Authentication

To protect your interactions with Neurax AI's API and safeguard your data, we use a robust authentication framework to ensure secure access.

Step 1: Obtaining Your API Key
  1. If you haven’t already generated an API key, follow the steps in the API Key Creation guide.

  2. Once generated, copy your API key from the Dashboard and store it securely.

    ⚠️ Important: Treat your API key like a password. Do not share it with unauthorized parties.


Step 2: OAuth 2.0 Authentication (Optional)

Neurax AI also supports OAuth 2.0, a widely-used authorization protocol. Here’s how you can set it up:

  1. Register your application with Neurax AI to obtain client credentials.

  2. Implement OAuth 2.0 in your app using the provided Client ID and Client Secret.

  3. Request an access token via the OAuth flow and include it in the authorization header of your API requests.

  4. For detailed steps, refer to the OAuth 2.0 Documentation available in the developer section.


{
    "Authorization": "Bearer ACCESS_TOKEN"
}


Step 3: Testing Authentication
  1. Use tools like Postman, cURL, or other HTTP clients to send test API requests.

  2. Verify that your authentication headers are correctly formatted and that you receive a valid response from Neurax AI servers.

  3. Example test request using cURL


curl -X GET "https://api.neuraxai.io/v1/market-data" \
-H "Authorization: Bearer YOUR_API_KEY"


Step 4: Troubleshooting Authentication

If you experience issues during the authentication process:

  1. Double-check your API key or access token for typos.

  2. Ensure your application is properly registered if you’re using OAuth 2.0.

  3. Review the API Documentation for proper usage of authentication headers.

  4. Still facing problems? Contact our Support Team for personalized assistance.

API Key Generation

Features Guides

© Copyright 2023. All rights reserved.