The Rebilly API is built on HTTP and is RESTful. It has predictable resource URLs and returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. Use your favorite HTTP/REST library in your programming language when using this API, or use one of the Rebilly SDKs, which are available in PHP and JavaScript.
Every action in the Rebilly UI is supported by an API which is documented and available for use, so that you may automate any necessary workflows or processes. This API reference documentation contains the most commonly integrated resources.
This topic describes the different forms of authentication that are available in the Rebilly API, and how to use them.
Rebilly offers four forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key.
To create or manage API keys, select one of the following:
For more information on API keys, see API keys.
Rebilly follows the error response format proposed in RFC 9457, which is also known as Problem Details for HTTP APIs. As with any API responses, your client must be prepared to gracefully handle additional members of the response.
Rebilly provides a JavaScript SDK and a PHP SDK to help interact with the Rebilly API. However, no SDK is required to use the API.
Rebilly also provides FramePay, a client-side iFrame-based solution, to help create payment tokens while minimizing PCI DSS compliance burdens and maximizing your customization ability. FramePay interacts with the payment tokens creation operation.
For installation and usage instructions, see SDKs. All JavaScript SDK code examples are included in the API reference documentation.
For installation and usage instructions, see SDKs. All SDK code examples are included in the API reference documentation. To use them, you must configure the $client as follows:
$client = new Rebilly\Client([ 'apiKey' => 'YourApiKeyHere', 'baseUrl' => 'https://api.rebilly.com', ]);
The full Rebilly API has over 500 operations. This is likely more than you may need to implement your use cases. If you would like to implement a particular use case, contact Rebilly for guidance and feedback on the best API operations to use for the task.
To integrate Rebilly, and learn about related resources and concepts, see Get started.
Rebilly enforces rate limits on the API to ensure that no single organization consumes too many resources. Rate limits are applied to the organization, and not to the API key. In sandbox environment, rate limits are enforced for non-GET endpoints and are set at 3000 requests per 10 minutes. You can find the exact number of consumed requests in the X-RateLimit-Limit and X-RateLimit-Remaining headers in the response. If the rate limit is exceeded, the API returns a 429 Too Many Requests response and a X-RateLimit-Retry-After header that includes a UTC timestamp of when the rate limit resets.
Use allowlists to exclude specific customer attribute data from risk score checks.
Allowlists are lists of data that are excluded from risk score checks. Allowlists prevent specific data from being added to a blocklist record when a risk score threshold reached.
Use Anti-Money Laundering (AML) operations to screen customers and help prevent your business from becoming directly or indirectly involved in criminal activity.
Use AML operations during customer creation, and some transaction processing, to help determine if a potential customer (lead), or customer, has political or economic sanctions against them.
AML operations search the following for screening purposes: Politically Exposed Persons (PEPs) lists, sanction lists, and adverse media lists.
Use API keys to identify and authenticate applications and users. Always keep your API keys private. When creating API keys, you can restrict them to a given set of permissions. For information on how to create and manage API keys, see API keys.
Use these operations to register applications to the Rebilly Apps Store and manage application instances. An application owner is a person or organization that has submitted an app to the Rebilly App Store. For more information, see Submit an app.
Use these operations to install or uninstall apps from the Rebilly App Store to your Rebilly account, and to manage application instances. An application user is a person or organization that uses an app that is installed from the Rebilly App Store. For more information, see Install or uninstall an app.
curl -i -X GET \ 'https://www.rebilly.com/_mock/catalog/all/application-instances/{applicationId}' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Application instance retrieved.
Status of the application instance.
Determines if the configuration of the application instance is complete. Configuration is completed using the Upsert an application instance configuration operation.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "status": "enabling", "isConfigured": true, "settings": { "color": "red", "limit": "5" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }
curl -i -X PUT \ 'https://www.rebilly.com/_mock/catalog/all/application-instances/{applicationId}' \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{}'
Application instance updated.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
Status of the application instance.
Determines if the configuration of the application instance is complete. Configuration is completed using the Upsert an application instance configuration operation.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "status": "enabling", "isConfigured": true, "settings": { "color": "red", "limit": "5" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }
curl -i -X DELETE \ 'https://www.rebilly.com/_mock/catalog/all/application-instances/{applicationId}' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{ "status": 401, "type": "http://example.com", "title": "string", "detail": "string", "instance": "string" }
curl -i -X GET \ 'https://www.rebilly.com/_mock/catalog/all/application-instances/{applicationId}/configuration' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{ "settings": { "color": "red", "level": "gold" }, "_links": [ { … } ] }