The API reference moved here from eksis.io/developers.
Channels

Start connecting a channel

POST
/v1/connect

Starts the platform sign-in for one of your customers and returns the url to send them to. The consent screen shows eksis. With returnUrl, the person comes back to your app with session, status, and platform in the query string. status is ok when accounts can be picked, denied when the person declined, error with code and message when the sign-in failed, or a reason nothing can be connected: no_pages, ig_not_business, no_channel, no_member, no_location, or no_shop. Without returnUrl the person lands on the eksis account picker. A session lasts 15 minutes. Platforms connected with a handle and an app password, such as Bluesky, are refused with connect.needs_credentials.

Authorization

headerAuthorizationBearer <token>

Send your key as Authorization: Bearer eksis_sk_....

Request Body

application/json
  1. body
platform*string
Value in"instagram""facebook""youtube""linkedin""tiktok""threads""x""bluesky""pinterest""google_business""shopee""devto""telegram""discord"
via?"instagram_login"

Instagram only: sign in with Instagram directly instead of through a Facebook Page.

Value in"instagram_login"
returnUrl?string

An https address of your app, or http://localhost while developing.

Lengthlength <= 2048

Response Body

The session started. Send the person to url.

application/json
  1. response
data?
curl -X POST 'https://api.eksis.io/v1/connect' \  -H 'Authorization: Bearer eksis_sk_...' \  -H 'Content-Type: application/json' \  -d '{  "platform": "instagram",  "via": "instagram_login",  "returnUrl": "https://your-app.example/eksis/connected"}'
{  "data": {    "sessionId": "string",    "platform": "string",    "url": "string",    "returnUrl": "string",    "expiresAt": "2019-08-24T14:15:22Z"  }}