Create your first Lumos integration: authenticate, create an app, and manage accounts. Get started with the Lumos API The Quick Start guide shows you how to create your first integration with Lumos. By the end of this tutorial, you’ll learn how to:

Authenticate with the Lumos API.
Create a sample application.
Create an account in the sample application.
List accounts in the sample application.

Prerequisites:

Lumos API Key (available in your dashboard).
Postman or a similar API client.
Basic knowledge of REST APIs.

To start, try one of the Lumos recipes.

Lumos API Hostname

https://api.lumos.com

Authentication

Lumos authenticates API requests using API keys. You will need to pass in a header to all requests to the Lumos API like this one.

Example cURL command

curl 'https://api.lumos.com/appstore/apps' \
	--header 'Authorization: Bearer lsk_example_1234'

API Tokens inherit and retain the permissions of the user that created them.

Creating an API token

Go to the API Tokens page in the Lumos settings.
Click “Add API Token”.
Enter a Name and a Description.
Click “Create API Token.”

Store your API token carefully. For security, Lumos shows the API Token only at creation time. All Lumos API Tokens are prefixed with lsk_.

1. Creating a sample application

cURL

curl -X POST "https://api.lumos.com/apps" \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
           "name": "Custom HR Portal",
           "category": "HR_AND_LEARNING",
           "description": "Internal HR management portal"
         }'

2. Creating a sample account with permissions

cURL

curl -X POST "https://api.lumos.com/accounts/upload" \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
           "app_id": "YOUR_APP_ID",
           "accounts": [
             {
               "unique_identifier": "john.doe",
               "email": "john.doe@example.com",
               "first_name": "John",
               "last_name": "Doe",
               "status": "ACTIVE",
               "permissions": [
                 {
                   "unique_identifier": "Role_1",
                   "type": "Standard",
                   "name": "Viewer"
                 }
               ]
             }
           ]
         }'

3. Listing the created account

cURL

curl -X GET "https://api.lumos.com/accounts?app_id=YOUR_APP_ID" \
     -H "Authorization: Bearer YOUR_API_TOKEN"

Testing the API

You can further test the API by using:

Developer Portal: developers.lumos.com
Postman: Postman Collection.

Quickstart

Lumos Connectors

Lumos

Guides

Webhooks

Examples

Tools

Recipes

Quick Start

Prerequisites:

Authentication

Creating an API token

1. Creating a sample application

2. Creating a sample account with permissions

3. Listing the created account

Testing the API

​Prerequisites:

​Authentication

​Creating an API token

​1. Creating a sample application

​2. Creating a sample account with permissions

​3. Listing the created account

​Testing the API

Prerequisites:

Authentication

Creating an API token

1. Creating a sample application

2. Creating a sample account with permissions

3. Listing the created account

Testing the API