The Northbeam API uses API keys to authenticate requests. If you don't have an API key or need to create a new one, you can easily generate it from the Settings page on our Dashboard. Simply go to Settings -> API Keys -> Create new API Key.

This will yield:

Data-Client-ID- a UUID used to identify you as the customer
API Key- Used to Authenticate the API call

Both will be used in making the API calls to Submit/Correct/Get Orders from our system

If you have any questions or encounter any difficulties while creating an API key, please don't hesitate to reach out to us at [email protected]. We're here to help.

Testing

When testing, you can use the following values without the need for production keys. In the testing environment, no orders are saved and we only return the results of validation.

--header 'Authorization: None'
--header 'Content-Type: application/json'
--header 'Data-Client-ID: test'

Testing with your user keys is also supported, though the development database is purged from time to time to limit storage bloat so it should only be treated as a testing environment and not a stable one.