Rebilly Experimental Reports API (0.1)

Download OpenAPI specification:Download

Introduction

This API is experimental and likely to change. We would appreciate feedback.

Authentication

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.

  • Secret API key: Use to make requests from the server side. Never share these keys. Keep them guarded and secure.
  • Publishable API key: Use in your client-side code to tokenize payment information.
  • JWT: Use to make short-life tokens that expire after a set period of time.

JWT

JWT is a short lifetime token that can be assigned a specific expiration time. To create a JWT session, see JWT session resource.

Usage format: Bearer <JWT>.

Security Scheme Type: HTTP
HTTP Authorization Scheme bearer
Bearer format: "JWT"

ApplicationJWT

Applications in our App Store can create a JSON Web Token (JWT) by fetching an user's instance.

Usage format: Bearer <JWT>.

Security Scheme Type: HTTP
HTTP Authorization Scheme bearer
Bearer format: "JWT"

PublishableApiKey

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

SecretApiKey

Never share your secret keys. Keep them guarded and secure.

Use your secret API key only to make requests from the server side. To authenticate, provide your secret key in the request header.

Security Scheme Type: API Key
Header parameter name: REB-APIKEY

CustomerJWT

You can create a JSON Web Token (JWT) via Storefront Authentication.

Usage format: Bearer <JWT>.

Security Scheme Type: HTTP
HTTP Authorization Scheme bearer
Bearer format: "JWT"

Manage API keys

To create or manage API keys, select one of the following:

  • Use the Rebilly UI: In the left navigation bar, Automations, Integrations, Custom integrations, then click API keys.
  • Use the Rebilly API: go to API Keys.

For more information, see API keys.

Javascript SDK

The Javascript SDK is maintained within Github, and contains the installation and usage instructions in the Readme file. SDK code examples are included in these docs.