Create REST API Key
Updated at: Created at:
This guide explains how to create a REST API key in LeadByte, which is required to authenticate all API requests. It walks you through accessing the REST API settings, creating a new key, choosing the correct key type, assigning permissions, and activating the key so it can be used for testing and integration.
Step 1 - Log in to LeadByte and go to: Admin → Tech Hub → REST API.
Step 2 - Click Add New API Key. You’ll see the configuration panel with a range of options.
Choose the appropriate key type based on your use case:
- Administrator = Full access to all API permissions. Not tied to any specific Supplier or Buyer.
- Supplier / Buyer = Limited to the permissions relevant to that Supplier or Buyer. Each key is linked to a single Supplier/Buyer record.
Additional Setting:
- Reference: Add a meaningful label for your key.
- API Version: Leave this as 1.3 unless instructed otherwise.
- Active: Ensure the key is activated before use.
Step 3 - Select the permissions this key should have by ticking the relevant checkboxes.
When you click a permission, detailed developer instructions will expand below to help you understand how that endpoint works in detail.
Step 4 - Click Save to generate your key. Once saved, you can begin testing your API requests using the newly created key.
Comments