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

Go live

The platform terms behind a product built on eksis, how to treat your customers' data, and a checklist before launch.

Before real customers connect their accounts, read how the platform terms apply to your product and go through the checklist at the end of this page.

Meta platforms

eksis connects Instagram and Facebook accounts as a Meta Tech Provider. Your customers sign in to the eksis app on Meta, and eksis passes their data on to your product through the API.

The Meta Platform Terms allow a Tech Provider to share platform data with its client when the client is bound by contract not to break Meta's terms. The eksis Terms of Service are that contract: they forbid using eksis in a way that breaks the Meta Platform Terms, the Instagram Community Guidelines, or the Facebook Community Standards. Those rules apply to everything your product does with data it gets through eksis.

In practice, that means:

  • Get your customers' consent. Tell each customer, in your own terms or onboarding, which accounts your product connects through eksis and what it does with their messages, comments, and posts.
  • Keep each customer's data separate. One workspace holds every customer's channels, so your code is what keeps them apart. List endpoints return every customer at once, so pass the customer's channel ids in channels whenever you read for one of them, check that a channel belongs to the customer before you act on it, and never show one customer another customer's conversations.
  • Use DM content only to serve that customer. Messages from a shop's buyers are there to answer those buyers on the shop's behalf, not for any other purpose, such as selling the data or using it for another customer.
  • Delete what you no longer need. When a customer leaves, disconnect their channels in the app and delete the messages and attachments you stored for them.
  • Follow the community rules in what you send. Replies, cards, and posts your product sends go out under your customer's account and must follow the Instagram Community Guidelines and the Facebook Community Standards.

Keys and secrets

  • Keep keys on your server. A key in a browser, a mobile app, or a repository can be read by anyone who opens them.
  • Give each key the smallest role. An admin key for connecting channels and setting up webhooks, an editor key for the code that replies and publishes, a viewer key for reporting. See Workspaces and limits.
  • Rotate the webhook secret when someone who knew it leaves, or on a schedule. The old one keeps working for 24 hours after a rotation.
  • Verify every webhook before trusting its body. See Receive events.

Keep channels healthy

Subscribe to channel.unhealthy and channel.disconnected. When a channel breaks, eksis holds its scheduled posts and your customer's DMs stop reaching you. Tell the customer right away and send them through the repair flow.

Before launch

  1. Connect your own Instagram or Facebook account through your app, from POST /v1/connect to select.
  2. Send a DM from a second account you own, receive message.received, and reply with text and with cards.
  3. Check that your code handles dm.window_closed, dm.conversation_too_many_replies, and a 429 with retry-after.
  4. Choose Send test on the endpoint in the app and check that your server verifies the event and answers 2xx within 10 seconds.
  5. Under Recent deliveries on the endpoint, choose Send again on a delivery and check that your code skips the repeat.
  6. Read GET /v1/me and check that limits covers the customers you expect in the first month.
  7. Make sure the keys and the webhook secret live only in your server's environment.

Test with your own accounts only. Messages and posts sent through the API go out on the real account and cannot always be taken back.

Help

Questions about building on eksis, higher limits for a workspace, or a platform refusing something it should allow: write to support@eksis.io with the workspace and the request that failed. Leave the API key out of the email.

On this page