Astarte.API.Pairing (astarte_device v1.0.3)
Astarte Pairing API access module.
Link to this section Summary
Functions
Create a client to access Pairing API.
Link to this section Functions
Link to this function
client(pairing_url, realm, opts \\ [])
Specs
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 base URL of the Astarte Pairing API instance the client will connect to, e.g. https://astarte.api.example.com/pairing
or http://localhost:4003
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 withAstarte.API.Pairing.Agent
or a credentials secret to use it withAstarte.API.Pairing.Device
.