Skip to content

Authentication

To interact with Jib Technologies API, you need to authenticate your requests. This guide explains how to obtain your API key, understand the key prefix based on the environment, and use the key to authenticate your requests.

Obtaining an API Key

Production Environment

  1. Go to the API Keys page on our website.
  2. Log in to your account or create a new one if you don’t have an account yet.
  3. Navigate to the ‘API Keys’ section.
  4. Click on the ‘Create New Key’ button.
  5. Enter a name for your key and ensure the environment is set to ‘Production’.
  6. Click ‘Create’.
  7. Your new API key will be displayed on the screen with a prefix of jt_prod_. Make sure to copy it and keep it in a safe place, as you won’t be able to see it again.

Sandbox Environment

  1. Go to the Sandbox API Keys page on our website.
  2. Follow the same steps as for the Production Environment, but ensure the environment is set to ‘Sandbox’.
  3. Your new API key will be displayed on the screen with a prefix of jt_dev_.

Authenticating Requests

To authenticate your requests to Jib technologies API, include the API key in the Authorization header of your HTTP request. The value of the header should be “Bearer” followed by a space and then your API key.

Here’s an example of how to set the Authorization header in a cURL request:

curl -X GET "https://api.jibtechnologies.com/endpoint" \
     -H "Authorization: Bearer jt_prod_YOUR_API_KEY"

Security Best Practices

  • Keep your API keys secure: Treat your API keys as sensitive information. Do not share them in public forums, code repositories, or with unauthorized individuals.
  • Limit key permissions: Only give your API keys the permissions they need to perform their intended functions.
  • Rotate keys regularly: Regularly rotate your API keys to minimize the impact of a compromised key. Troubleshooting

Troubleshooting

If you are having trouble authenticating to the API, ensure that:

  • Your API key is correct and hasn’t been revoked.
  • You are including the API key in the Authorization header correctly, with the “Bearer” prefix.
  • Your request is well-formed and correctly formatted.
  • If you continue to experience issues, please contact our support team for assistance.