Initial setup
Follow these steps to begin using the Teal API.
Create a developer account
Once you have a Sandbox Platform, visit the Developer Portal and create an account using your company email address.
Generate your API token
You can generate and manage API tokens from within the Developer Portal.
API tokens are scoped to one of two API environments:
- Sandbox Platforms:
https://api.sandbox.teal.dev
- Production Platforms:
https://api.teal.dev
Sandbox is intended to be used during development. Once you are ready to go live, we will create a Production Platform for you. Calls to our API require a bearer token and are sent to our API using an Authentication: Bearer <token>
HTTP header.
Make a test API call
Test that you are setup correctly by making a test call to the Retrieve Platform endpoint.
Run the following cURL command in your client and replace <API token>
with your API token:
If successful, you should see a response that looks like the following: