Download OpenAPI specification:Download
This document covers APIs mostly intended for consumption by Rebilly's Frontend GUI app. However, any client is welcome to use these APIs. Our main API docs can be found here.
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.
JWT is a short lifetime token that can be assigned a specific expiration time. To create a JWT session, see JWT session resource.
Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance. For more information, see Retrieve an application instance.
This authentication method is applicable to specific operations.
To create a publishable API key, see Create an API key.
To create a JSON Web Token (JWT) using Storefront authentication, see Create a session with username and password.
To create or manage API keys, select one of the following:
For more information on API keys, see API keys.
Installation and usage instructions can be found here. SDK code examples are included in these docs.
For all PHP SDK examples provided in this spec you will need to configure
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
Fields in filter are separated with
You can use multiple values using
, as values separator:
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:
You can use gte (greater than or equals) filter like this:
?filter=amount:1.., or lte (less than or equals) than filter like this:
You can create some specified values lists and use them in filter:
?filter=firstName:@yourListName. You can also exclude list values: