Connect

Connect a social account: send the user to the URL, Crier brings them back to your redirectUrl.

Start connecting an account

GET/v1/connect/{platform}

Returns the URL to send the user to. When they finish, Crier redirects to redirectUrl with connected=<platform>&accountId=…, with error=… if it failed, or with select=<sessionId> when the user must pick a page, organization, board, location or profile (Facebook, LinkedIn, Pinterest, Google Business, Snapchat). In that case list the options and select one.

Parameters

platformstringrequired
profileIdstringrequired
The profile the account will belong to.
redirectUrlstring (uri)required
Where Crier sends the user back when the connection finishes.

Response 200

data

urlstring (uri)required
Send the user here to authorize the network.

curl "https://api.usecrier.com/v1/connect/instagram?profileId=prf_8f2k4d&redirectUrl=https%3A%2F%2Fapp.acme.com%2Fconnected" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/connect/instagram?profileId=prf_8f2k4d&redirectUrl=https%3A%2F%2Fapp.acme.com%2Fconnected', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/connect/instagram?profileId=prf_8f2k4d&redirectUrl=https%3A%2F%2Fapp.acme.com%2Fconnected",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

List what the user can pick

GET/v1/connect/sessions/{id}/options

The id is the select value Crier added to your redirectUrl. Sessions expire after one hour.

Parameters

idstringrequired

Response 200

data

platformstringrequired
optionsobject[]required
options
- idstringrequired
- namestringrequired
- detailstring
- imageUrlstring (uri)

curl "https://api.usecrier.com/v1/connect/sessions/cs_5t2y8u/options" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/connect/sessions/cs_5t2y8u/options', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/connect/sessions/cs_5t2y8u/options",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Pick an option and finish connecting

POST/v1/connect/sessions/{id}/select

Parameters

idstringrequired

Body

optionIdstringrequired
max 200

Response 201

data

idstringrequired
profileIdstringrequired
platformstringrequired
usernamestring
displayNamestring
avatarUrlstring (uri)
statusstringrequired
Values: active · needs_reconnection · disconnected
connectedAtstring (date-time)required
updatedAtstring (date-time)required

curl -X POST "https://api.usecrier.com/v1/connect/sessions/cs_5t2y8u/select" \
  -H "Authorization: Bearer $CRIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "optionId": "1042…"
  }'

const res = await fetch('https://api.usecrier.com/v1/connect/sessions/cs_5t2y8u/select', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "optionId": "1042…"
  }),
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/connect/sessions/cs_5t2y8u/select",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
    json={
        "optionId": "1042…"
    },
)
data = res.json()["data"]