Authentication

This section will elucidate the utilization of the API key and signature provided for accessing our API, along with recommendations and instructions on generating new API keys.

Suggest Edits

API Authentication Documentation

Welcome to the documentation for authenticating requests to our API. This guide will walk you through the authentication process using API keys.

Authentication Method

Our API requires authentication using API keys. Each request must include two headers:

  1. api-key: This header should contain your unique API key.
  2. sign: This header should contain a signature for the request, generated using your API key and the request data.

Getting Started

To start using our API, you need to obtain an API key. Follow these steps:

  1. Sign Up: If you haven't already, sign up for an account on our platform.
  2. Generate API Keys: Once logged in, navigate to the API Keys section in your account dashboard.
  3. Create New API Key: Generate a new API key and assign it a name or description to identify its purpose.
  4. Note: Make sure to securely store your API keys. Do not expose them publicly or share them with unauthorized users. The api-key will be showed only when generated so keep it stored.

Once you have your API keys, you can start making requests to our API. Here's how to include the API keys in your requests:

curl --location 'https://workspaces.api.sad.jelp.io/dev/v3/order/status/update' \
--header 'api-key: {{api-key}}' \
--header 'sign: {{sign}}' \
--header 'Content-Type: application/json' \
--data '{
    "status": "ACCEPTED",
    "referenceId": "423DK7T"
}'

Replace {{api-key}} with your actual API Key and {{sign}} with the signature provided

Managing API Keys

You can manage your API keys within the API Keys section of your account dashboard. Here are some key actions you can perform:

  • Create New Key: Generate a new API key.
  • Edit Key Details: Modify the name or description of an existing API key.
  • Disable Key: Temporarily disable an API key without deleting it.
  • Delete Key: Permanently delete an API key.
  • Replace Key: Generate a new API key to replace an existing one.

Security Considerations

  • Keep API Keys Secure: Avoid exposing your API keys in publicly accessible code or repositories.
  • Rotate API Keys: Periodically rotate your API keys for added security.
  • Use HTTPS: Always make requests to our API over HTTPS to encrypt data and protect against man-in-the-middle attacks.

Conclusion

By following this authentication process and managing your API keys securely, you can ensure the integrity and security of your interactions with our API. If you have any questions or issues, feel free to contact our support team.

Thank you for choosing our API!

Updated 6 months ago