Prerequisites
- A Lumos user who can create API tokens.
- curl, Postman, or a similar API client.
- Basic knowledge of REST APIs.
Lumos API Hostname
1. Create an API token
- Go to the API Tokens page in the Lumos settings.
- Click “Add”.
- Enter a name and a description.
- Click “Add”.
- Copy the token value.
lsk_. A token can
do what the user who created it can do, as Authentication describes.
2. Make your first call
Send the token as a bearer token on every request. This call returns the user the token belongs to:cURL
401 means Lumos didn’t accept the token. Check the header format, then check that the token
still exists.
3. Build something
Connect your first app
Find an integration, read the credentials it needs, and connect it.
Upload accounts to a custom app
Create an app Lumos has no integration for, and send its accounts.
Set up an app in the AppStore
Give an app entitlements and approvers, and make it requestable.
Recipes
Short scripts for common tasks.