Building a platform integration
PreviewHow a commerce platform offers RowCall flows to merchants through the API, and what's coming for platforms with many merchants.
If you run a platform that serves many stores, you can offer RowCall flows to them through one integration. This is how Glood connects.
How it works today
- One org, its own keys. Each API key belongs to one RowCall org and acts only for it: its flows, runs, contacts, opt-outs, settings and billing. See Authentication and keys.
- Your references travel with the run. Send up to 20 references of your own in
metadata, such as the store and order, when you start a run. They come back on the run and in every event. - One action URL and webhook endpoints per mode. They're set in the org's Developers page, HTTPS only, and never taken from run inputs.
Platforms with many merchants
If many stores use your platform, register an app and let each merchant connect their RowCall org over OAuth. You get a token per org, one webhook URL and one action URL for all of them, and every request names the merchant's orgId. See Build an integration.
What you build
Send events as runs
When a checkout stalls, a payment fails or an order needs checking, start a run with
POST /v1/runs, the inputs, the shopper's consent and yourmetadata. See Start a run, and every field in the API reference.Define your actions
Save the actions your platform can perform with
PUT /v1/actions/:name, starting from RowCall's presets or your own. Flows can then allow them. See Actions.Answer action requests
Host an action endpoint in India. Check every request against the store's own data before acting, and reply within the action's timeout.
Handle events
Receive webhook events, update orders from outcomes, and stop runs for shoppers who opted out (
optout.received). See Webhooks and every event's body in the API reference.Capture consent
Add the consent checkbox to your merchants' checkouts, and send the record with each run or with
PUT /v1/contacts. See Consent records.
Rules for platforms
- A request for one store must never touch another store's data. Check your
metadataand the order against the store before acting. - Honour opt-outs at once.
- Test everything in test mode before any store goes live.
Talk to us
RowCall registers platform apps with you, since your merchants will trust the access they approve. Tell us about your platform and your merchants through Contact.
Next stepActionsDesign the actions your platform will offer.