API keys

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

This topic describes API keys and how to use them in Rebilly.

The following key types are available:

• Secret key: Use to authenticate requests on a server. By default, secret keys can be used to perform any API request without restriction. Secret keys must be kept secret and stored securely in the server-side code of your web or mobile application.
• Publishable key: Use to tokenize payment information in your client-side code. Publishable keys are publicly accessible in a web browser or mobile application. Publishable keys are mainly used to create tokens, which are a representation of a payment source that hides sensitive information.

When interacting with the Rebilly API, you use your organization ID and secret key to authenticate requests. This CURL request describes how to authenticate a request using a secret key. To obtain your secret key, seeObtain a secret key. To obtain your organization ID, seeObtain an organization ID.

curl 'https://api-sandbox.rebilly.com/organizations/your_organization_id' \-H'REB-APIKEY: your_secret_API_key'

API key format

API keys use the following format:type_environment_tokenizedPayload

Manage API keys

This section describes how to manage API keys.

Create an API key

Use this process to create new API keys.

1. In the left navigation bar, press Automations.
2. In theDevelopment section, pressAPI keys.
3. In top right of the screen, pressCreate API key.
4. In theDescription field, enter a recognizable name for the key.
5. In theType section, selectSecret orPublishable.
6. Optionally, in theOrganizations dropdown, select an organization to associate with the key.
7. Optionally, in theAllowed IPs field, enter a list of IP address that are permitted to use the API key.
   Note: LeavingAllowed IPs field empty allows all IP addresses.
8. PressSave API Key to store API key.

Obtain an API key

Use this process to view and obtain API keys.

1. In the left navigation bar, press Automations.
2. In theDevelopment section, pressAPI keys.
3. In the API keys table, under theKey column, press Copy.

Obtain a publishable API key

Use this process to obtain a publishable API key. This key is required to interact with the Rebilly API.

1. In the left navigation bar, press Automations.
2. In theDevelopment section, pressAPI keys.
3. Optionally, if you have not created a publishable key:
   1. In top right of the screen, pressCreate API key.
   2. In theDescription field, enter a recognizable name for the key.
   3. In theType section, selectPublishable.
   4. Optionally, in theOrganizations dropdown, select the organizations that can use the API key.
   5. Optionally, in theAllowed IPs field, enter the IP addresses that are permitted to use the API key.
   6. PressSave API key.
   7. Go to the API keys page.
4. Select a publishable key and copy theKey value.

Obtain a secret key

Use this process to obtain a secret key.

1. In the left navigation bar, press Automations.
2. In theDevelopment section, pressAPI keys.
3. Optionally, if you have not created a secret key:
   1. In top right of the screen, pressCreate API key.
   2. In theDescription field, enter a recognizable name for the key.
   3. In theType section, selectSecret.
   4. Optionally, in theOrganizations dropdown, select the organizations that can use the API key.
   5. Optionally, in theAllowed IPs field, enter the IP addresses that are permitted to use the API key.
   6. PressSave API key.
   7. Go to the API keys page.
4. Select a secret key and copy theKey value.

Edit or delete an API key

Use this process to edit or delete an API key.

1. In the left navigation bar, press Automations.

2. In theDevelopment section, pressAPI keys.

3. Select from the following:

   • Edit an API key:

     1. In the API keys table, under theName column, press an API key.
     2. Edit the API key, then pressSave API key.

   • Delete an API key: In the API keys table, on the right of an API key, press Delete.

Associate keys with organizations

To ensure that an API request is handled by the intended Rebilly account, always include theorganizationId in the request URL. API keys are associated with the user who creates them. In Rebilly, a user may be a member of one or more organizations, and may also join or leave organizations. Example:https://api-sandbox.rebilly.com/organizations/{organizationId}/customers.

To associate an API key with an organization, when you create or edit a key, in theOrganizations dropdown, select an organization. For more information, seeCreate an API key orEdit an API key.