Skip to main content

🔑 Access Your API Key

To use the Komship Delivery API, you must first retrieve your API key from the Collaborator dashboard. This API key is essential for authenticating your requests and accessing the services provided by the API.

📍 Where to Find Your API Key​

Follow these steps to locate your API key:

  1. Login to your Collaborator Dashboard
  2. Navigate to the Setting menu
  3. Click on Profile
  4. Select Menu Tab API Key
  5. Unlock your Shipping Delivery APIKEY.
warning

⚠️ Keep your API key secure. Do not share it or expose it in public-facing code or repositories.

🛠 Select the Correct API Key​

Komerce may offer multiple API keys for different services. Make sure to:

  • Use the API key labeled Shipping Delivery.
  • Do not use API keys intended for other services (e.g., RajaOngkir, Shipping Cost, etc.)
danger

Using the wrong API key will result in failed authentication or limited functionality.

📬 How to Use the API Key​

Include your API key as a Middleware in the HEADER of each API request:

x-api-key: YOUR_API_KEY

Example Request with cURL​

curl --request GET \
  --url https://api-sandbox.collaborator.komerce.id
  --header 'x-api-key: YOUR_API_KEY'

This will return the list of available couriers for your delivery orders.

If your API key is compromised or you need to rotate it, you can regenerate a new one from the same API Key section in your Komerce dashboard.