Partner API's

Welcome to the RBI Partner API developer guide!
This document provides an overview of how to integrate with the RBI platform using our Partner API.

The Partner API serves as an orchestration layer, facilitating a connection between external partners, and with the RBI platform ecosystem, including our whitelabel application.

The RBI Partner API offers two primary methods of communication:

• Endpoints: Used when partners need to push information to RBI.

• Webhooks: Used when RBI needs to push information to partners.

[to-do Diagram]

Integrations

Upon setting up your integration with RBI, you will receive unique JWTs, for each environment (Staging and Production), for your specific country and brand.

For all API requests, include the JWT in the Authorization header of your HTTP request:

Integrations contain essential information about your application, such as the stores it connects to, and the webhooks it has.

These attributes, amongst others, can be updated by partners, using the Admin API (to-do add link).

Endpoints

API endpoints are a crucial component of the RBI Partner API, allowing partners to actively interact with the RBI platform and other partners within the ecosystem. These endpoints provide a way for partners to push information, trigger actions, and retrieve data.

Authentication

…

Webhooks

Webhooks are defined as a pair of two attributes, their type, which defines in which context it will be used, and a url, which will be used to send the request to.

Contents