Releasesv0.1.0
Connections

Start connecting a provider

POST
/v1/users/{id}/connections/{provider}

Returns the provider's consent URL. Send the user there; after consent the user lands on redirect_uri?status=connected|error&provider=<slug>, or on a built-in result page when no redirect_uri is given. Each call mints a fresh single-use state; Idempotency-Key is not honoured here. While the user's data from this provider is being deleted the answer is 409: connect again once the deletion job is done.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

id*string
Formatuuid
provider*string

Connector slug, see GET /v1/providers.

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Request Body

application/json
  1. body
redirect_uri?string
Formaturi

Response Body

Consent URL.

application/json
  1. response
authorize_url*string
Formaturi
curl -X POST 'http://localhost:8080/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/connections/withings' \  -H 'Authorization: Bearer ohs_sk_...' \  -H 'Content-Type: application/json' \  -d '{}'
{  "authorize_url": "http://example.com"}
Edit on GitHub