Rebilly REST API Overview
Version information
2.1
2.1
The Rebilly API is built on HTTP. Our API is RESTful. It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. You can use your favorite HTTP/REST library for your programming language to use Rebilly's API, or you can use one of our SDKs (currently available in PHP and Javascript).
We have other APIs that are also available. Every action from our app is supported by an API which is documented and available for use so that you may automate any workflows necessary. This document contains the most commonly integrated resources.
When you sign up for an account, you are given your first secret API key. You can generate additional API keys, and delete API keys (as you may need to rotate your keys in the future). You authenticate to the Rebilly API by providing your secret key in the request header.
Rebilly offers three forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key.
Never share your secret keys. Keep them guarded and secure.
You can create a JSON Web Token (JWT) via our JWT Session resource.
Usage format: Bearer <JWT>
.
Security Scheme Type | HTTP |
---|---|
HTTP Authorization Scheme | bearer |
Bearer format | "JWT" |
Only for the Tokens resource.
You can create a Publishable API Key via our API Keys resource, by specifying the type as publishable
.
Security Scheme Type | API Key |
---|---|
Header parameter name: | Authorization |
When you sign up for an account, you are given your first secret API key. To do so please follow this link. Also you can generate additional API keys, and delete API keys (as you may need to rotate your keys in the future). All API keys can be restricted to a small set of permissions (restricted API keys).
Security Scheme Type | API Key |
---|---|
Header parameter name: | REB-APIKEY |
Rebilly follow's the error response format proposed in RFC 7807 also known as Problem Details for HTTP APIs. As with our normal API responses, your client must be prepared to gracefully handle additional members of the response.
Access forbidden.
type | string <uri> A URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". |
status | integer [ 400 .. 599 ] The HTTP status code. |
title | string A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. |
detail | string A human-readable explanation specific to this occurrence of the problem. |
error | string Deprecated |
property name* | any |
{- "status": 400,
- "title": "string",
- "detail": "string",
- "error": "string"
}
Conflict.
type | string <uri> A URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". |
status | integer [ 400 .. 599 ] The HTTP status code. |
title | string A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. |
detail | string A human-readable explanation specific to this occurrence of the problem. |
error | string Deprecated |
property name* | any |
{- "status": 400,
- "title": "string",
- "detail": "string",
- "error": "string"
}
Resource was not found.
type | string <uri> A URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". |
status | integer [ 400 .. 599 ] The HTTP status code. |
title | string A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. |
detail | string A human-readable explanation specific to this occurrence of the problem. |
error | string Deprecated |
property name* | any |
{- "status": 400,
- "title": "string",
- "detail": "string",
- "error": "string"
}
Invalid data was sent.
type | string <uri> A URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". |
status | integer [ 400 .. 599 ] The HTTP status code. |
title | string A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. |
detail | string A human-readable explanation specific to this occurrence of the problem. |
error | string Deprecated |
Array of objects | |
property name* | any |
{- "status": 400,
- "title": "string",
- "detail": "string",
- "error": "string",
- "invalidFields": [
- {
- "field": "field1",
- "message": "field1 is invalid"
}, - {
- "field": "subObject.field2",
- "message": "field2 is invalid"
}, - {
- "field": "subObject.field2",
- "message": "another error in the field2"
}
]
}
Rebilly offers a Javascript SDK and a PHP SDK to help interact with the API. However, no SDK is required to use the API.
Rebilly also offers FramePay, a client-side iFrame-based solution to help create payment tokens while minimizing PCI DSS compliance burdens and maximizing the customizability. FramePay is interacting with the payment tokens creation operation.
Installation and usage instructions can be found here. SDK code examples are included in these docs.
For all PHP SDK examples provided in these docs you will need to configure the $client
.
You may do it like this:
$client = new Rebilly\Client([
'apiKey' => 'YourApiKeyHere',
'baseUrl' => 'https://api.rebilly.com',
]);
Rebilly provides collections filtering. You can use ?filter
param on collection to define which records should be shown in the response.
Here is filter format description:
Fields and values in filter are separated with :
: ?filter=firstName:John
.
Fields in filter are separated with ;
: ?filter=firstName:John;lastName:Doe
.
You can use multiple values using ,
as values separator: ?filter=firstName:John,Bob
.
To negate the filter use !
: ?filter=firstName:!John
. Note that you can negate multiple values like this: ?filter=firstName:!John,Bob
. This filter rule will exclude all Johns and Bobs from the response.
You can use range filters like this: ?filter=amount:1..10
.
You can use gte (greater than or equals) filter like this: ?filter=amount:1..
, or lte (less than or equals) than filter like this: ?filter=amount:..10
.
You can create some predefined values lists and use them in filter: ?filter=firstName:@yourListName
. You can also exclude list values: ?filter=firstName:!@yourListName
Rebilly provides the ability to pre-load additional objects with a request.
You can use ?expand
param on most requests to expand
and include embedded objects within the
_embedded
property of the response.
The _embedded
property contains an array of
objects keyed by the expand parameter value(s).
You may expand multiple objects by passing them as comma-separated to the expand value like so:
?expand=recentInvoice,customer
And in the response, you would see:
"_embedded": [
"recentInvoice": {...},
"customer": {...}
]
Expand may be utilitized not only on GET
requests but also on PATCH
, POST
, PUT
requests too.
Rebilly's API has over 300 operations. That's more than you'll need to implement your use cases. If you have a use case you would like to implement, please consult us for feedback on the best API operations for the task.
Our getting started guide will demonstrate a basic order form use case. It will allow us to highlight core resources in Rebilly that will be helpful for many other use cases too.
Within 25 minutes, you'll have sent API requests (via our console) to create a subscription order.