Sign in

v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB
Auth

Create a Connect URL

You can also send your users through the Connect flow by linking them to a unique Connect URL (provided by this endpoint).

Just like the Connect Token, you need to provide either a client_user_id or autility credential_id to get a URL that will initialize Connect in ‘create mode’ or ‘update mode’ respectively. See this page for a guide on the difference between those two modes. This endpoint will provide a URL in a response. Once you have the URL, provide it to the given user for them to complete Connect and give you access to their utility data. The URL will expire after 5 days. If you would like to provide your user with the [Connect tariff selection mode] (https://docs.arcadia.com/docs/connect-tariff-selection-mode) instead, pass tariff as the variant parameter.

post/auth/connect_url

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

client_user_idstring

The unique identifier for your user. This parameter is required for users entering the Connect flow for the first time. Note either client_user_id or utility_credential_id must be supplied to the endpoint for all requests.

utility_credential_idinteger

The id associated with the utility credential to be updated. This parameter is required for users entering Connect to update or repair an existing utility credential. Note that you must supply either client_user_id or utility_credential_id to the endpoint.

variantstring

The variant of Connect that the user will be sent through. Variant will default to 'connect'. To provide a user with the tariff-selection variant instead, pass tariff as the variant

Example request

{
  "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
  "utility_credential_id": 1,
  "variant": "tariff"
}

Response

Success

connect_urlstring required

The url to be used for initializing standalone Connect.

Example response

{
  "connect_url": "https://connect.arcadia.com?token=QYEPoBOJWc4bV_XpIzJdr8BLG4RdK6h68AP672nab4f"
}