Introduction
The Celbux API is a REST API that utilizes secure HTTP calls for seamless integration and communication with our platform. This document provides a comprehensive guide to the various API calls available. All requests to the Celbux API are made via POST, and the request and response payloads are always formatted in JSON. For the Admin and Merchant APIs, all fields are of type STRING.
Acquiring Credentials
Section titled “Acquiring Credentials”To access the Celbux API, developers need to acquire a valid bearer token and an active URL endpoint. Please ensure you have the following credentials to begin. We will supply this information to you directly. If not, please contact integrations@celbux.com to get started.
- URL Endpoint: The
{api-url}supplied for the environment you are using. - Bearer Token: The authentication token supplied.
- Customer & Merchant Details: Test usernames and passwords.
- Store ID: A unique store identifier code for the merchant.
- Community: The community you will be operating in.
Environments & Testing
Section titled “Environments & Testing”Celbux provides a simulation environment for developers to facilitate end-to-end development & testing for their product. In this environment, you will receive a dedicated bearer token, test customer, and test merchant with a valid store ID. The simulation environment mirrors our live environment one-to-one, meaning the switch-over will be seamless.
You can log in & access your supplied accounts via the official test web app located at test.celbux.com. Here, you can test many features of the platform, allowing you to understand our system better before integrating via API.
Once the testing phase is complete, we will issue new credentials to you for the live environment.
Call Structure
Section titled “Call Structure”This section describes the format for each API call moving forward. The {api-url} specified below needs to be replaced by the URL endpoint supplied to you. The {community} must also be replaced with the community supplied to you.
POST {api-url}/endpoint?ns={community}
This section will detail the parameters required in the request body and the structure of the response. Any required fields that are left out, or fields that are populated incorrectly, will cause the call to fail.
Parameters
Section titled “Parameters”| Field | Type | Requirement | Description |
|---|---|---|---|
Field1 | String | Required | Field description. |
Field2 | Integer | Optional | Field description. |
Example Body
Section titled “Example Body”{ "Field1": "Value 1", "Field2": 2}Parameters
Section titled “Parameters”| Field | Type | Description |
|---|---|---|
ResponseField1 | String | Response field description. |
ResponseField2 | Integer | Response field description. |
Example Body
Section titled “Example Body”{ "ResponseField1": "Response 1", "ResponseField2": 2}