Search…
Authentication
New app, who dis? We secure calls with your Builton API key and a JSON Web Token. Here's how to use them.

Your BuiltOn API Key

This is found in your BuiltOn dashboard in Settings. Every request must have it included in the X-Builton-Api-Key Header.
1
X-Builton-Api-Key: <builton-api-key>
Copied!
Here is how it would look like if you were to list your products:
1
GET /products HTTP/1.1
2
Content-Type: application/json
3
X-Builton-Api-Key: <builton-api-key>
4
Host: api.builton.dev
Copied!

The JSON Web Tokens

You'll get these from your Authentication Provider, or create them yourself if you're using a custom authentication solution. Once you've set that up in the dashboard, you'll use those JWTs to connect with our APIs using the Authorization header.
1
Authorization: Bearer <jwt>
Copied!
Here's how they'd look if you were creating a user:
1
POST /users HTTP/1.1
2
Content-Type: application/json
3
Authorization: Bearer <jwt>
4
X-Builton-Api-Key: <builton-api-key>
5
Host: api.builton.dev
Copied!
Make sure to includeBearerbefore the JWT.