astarte_device

v0.11.0

astarte_device v0.11.0 Astarte.API.Pairing

Astarte Pairing API access module.

Link to this section Summary

Functions

client(pairing_url, realm, opts \\ [])

Create a client to access Pairing API.

Link to this section Functions

Link to this function

client(pairing_url, realm, opts \\ [])

client(
  pairing_url :: String.t(),
  realm :: String.t(),
  opts :: Astarte.API.client_options()
) :: Astarte.API.client()

Create a client to access Pairing API.

pairing_url is the URL of the Astarte Pairing API instance the client will connect to, up to (and including) /v1. E.g. https://astarte.api.example.com/pairing/v1 or http://localhost:4003/v1 for a local installation.

realm is the realm that the API will access

opts is a keyword list of additional options detailed below

Options

  • :auth_token - Auth token that will be used as authorization when accessing Pairing API. This can be a JWT to use it with Astarte.API.Pairing.Agent or a credentials secret to use it with Astarte.API.Pairing.Device.