Authentication

Secure authentication is crucial for using the KBOSS API. This guide will walk you through the process of creating and using an API key, which is essential for authenticating your requests.

Creating an API Key

  1. Access API Keys Tab: Log in to your KBOSS organization and navigate to the "API Keys" tab in your Project.

  2. Generate New API Key: Click on the option to create a new API key. This key will be used to authenticate your requests to the KBOSS API.

  3. API Key Generation Confirmation: Once generated, you'll be presented with a new API key.

Save your API key in a secure location immediately. It is only displayed once for security reasons. If you lose this key, you won't be able to retrieve it again and will need to generate a new one.

Using Your API Key

  • Incorporate in Requests: Use the API key in your HTTP requests to the KBOSS API. This key is required in the X-KBOSS-Authorization header for authentication.

  • cURL Command Example: Here’s how you can use the API key in a cURL command:

    curl --location 'http://acmemedical.gcp.cocooncloud.com/proxy/buenbyaconxlf6uu' \
--header 'X-KBOSS-Authorization: [Your_API_Key]' \
--header 'X-KBOSS-Destination: [Destination_URL]' \
--header 'Content-Type: application/json' \
--data '[Your_JSON_Payload]'

    Replace [Your_API_Key], [Destination_URL], and [Your_JSON_Payload] with your actual API key, the destination URL, and the JSON payload, respectively.

Best Practices

  • Keep It Confidential: Treat your API key as sensitive information. Only share it with team members who require it for their work.

  • Regenerate If Necessary: If you suspect that your API key has been compromised, generate a new one immediately and update your applications accordingly.

By following these steps and guidelines, you can ensure secure and effective authentication for your interactions with the KBOSS API.