API Access - disk91/helium-chirpstack-community GitHub Wiki

The Chirpstack solution supports GPRC and REST-API following the Chirpstack standards.

GRPC API

GPRC is the Chirpstack standard way to automate Chirpstack actions. The GPRC development requires a certain level of expertise as the payload are encoded, the documentation hard to find. We do not provide support on GPRC API, you can refer to Chirpstack community forum and Chirpstack API documentation.

With your browser developer options, you can easily find the GRPC endpoint for the different possible action, base endpoint are on https://console.helium-iot.xyz/api.*

To use API, you need to use an API-KEY. API-KEY creation is made in Chirpstack, per tenant, with the API Keys menu on the left. The authorization is made adding header:

User-Agent: your-application-name
Authorization: Bearer apikey

Better to identify your application with a user agent for later possible API evolutions

REST API

REST API is the easiest way to automate your action on Chirpstack as you can test your API online and easily construct your payload and debug your requests. You can access the REST-API Chirpstack documentation. The API endpoint are on https://console.helium-iot.xyz/api/

To generate the Curl command line, you can click on Authorize button and setup your authorization. You need to type Bearer followed by your api-key. Then you can use the try it out buttons in the documentation page.

The Authorization is made the same way, adding Authorization or Grpc-Metadata-Authorization header:

User-Agent: your-application-name
Authorization: Bearer apikey

Better to identify your application with a user agent for later possible API evolutions