The API is available via WebSocket or via REST. We provide several client libraries for different languages.
In order to send requests to our API, you will first need to create an API key and API token . You can get these here . Your API key and token should always be stored securely and stay private : this token pair should be considered your username and password to Luzmo!
There are multiple types of tokens; for more information about each token or how to create them programmatically, refer to the Authorization Resource.
The libraries below are built around the REST API. The code and installation instructions for each language can be found in the respective README file:
| Language | Package & Source |
|---|---|
| Node.js | npm & GitHub |
| PHP | Packagist & GitHub |
| Java | Maven & GitHub |
| C# | Nuget & GitHub |
| Python | PyPI & GitHub |
These libraries require a connection step where you provide the api key and token to get started. Sometimes the token has to be one for a specific user. For example binding a locale to a User requires you to be owner of that user. You can take ownership by using the login/api token of that specific user.
You can also access our API without a library using pure rest calls in which case you have to pass the api key and token on each call. For pure REST examples you can refer to the curl examples.
Connect to the API
const Luzmo = require('@luzmo/nodejs-sdk');
const client = new Luzmo({
api_key: '< your API key >',
api_token: '< your API token >',
host: '< https://api.luzmo.com (default) or https://api.us.luzmo.com or your VPC-specific address >'
});