Skip to main content

Getting Started

To start using the Onoff Business API follow the next steps

  1. Authentication: Obtain your API key from the dashboard in b2bconsole (coming soon)
  2. Base URL: All API requests should be made to the base URL https://public-apigateway.onoffapp.net
  3. Headers: Include your API key in the request headers
  4. Format: All requests and responses should use JSON format

Authorization

API keys are essential for securing APIs. Onoff generates a unique API key per organization, which can be created in the B2B console by users with admin role permissions. This mechanism prevents unauthorized access and protects Onoff's infrastructure from attacks.

The API key provides an initial layer of security and must be included in the HTTP headers as follows.


x-api-key: <token>