Skip to main content

​
API Key Management

HyperRail provides two types of API keys for different use cases: public keys and secret keys. You can manage these keys from your HyperRail dashboard.
  • Secret Keys (sk_test_ for test mode, sk_live_ for live mode): Used exclusively for server-to-server communications and backend integrations. These keys grant full access to your account and must be kept confidential. Never share your secret keys in public locations like code repositories (GitHub), client-side code, or other unsecured environments.

​
Authentication Process

All server-side API requests to HyperRail must be authenticated using your secret key. Here’s how to authenticate:
  • Include your secret key in the Authorization header of every request using the Bearer token format.
  • HTTPS is mandatory: All API requests must be made over HTTPS for secure communication. Requests made over plain HTTP will fail.
  • Authentication Failure: Calls made without proper authentication will result in a 401 Unauthorized status code response from the API.
Secure your API requests by including an Authorization header in the following format:

Authorization: Bearer SECRET_KEY

 
{
    "Authorization": "Bearer sk_test_6988f8d1539a48ab945764ec361fa3eb"
}
To test functionalities specific to your account, you’ll need to replace this sample key with your own. By following these guidelines, you can ensure secure and authorized access while integrating with HyperRail’s APIs.