Authentication

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.

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.

Please always include the following headers in your API requests in the production environment.

--header 'Authorization: Basic {API Key}'
--header 'Content-Type: application/json'
--header 'Data-Client-ID: {your client id}'

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'