Private APIs


Private APIs

Within the Rakuten RapidAPI platform, you can create private, or internal APIs. By default, all newly added APIs on Rakuten RapidAPI are set to private. This is perfect for companies or individuals that do not want their API to be publicly available.

Rakuten RapidAPI is a great solution for teams that require a sandbox or the ability to offer access to select clients. Another option is to develop and test your private API in a secure location.

If and when you’re ready to make your API public, follow these simple steps:

  1. Log in to the Rakuten RapidAPI Provider Dashboard
  2. Navigate to your API’s Settings tab
  3. Scroll to the bottom of the page and locate the ‘API Visibility’ section
  4. Hit the Visibility switch.

You will need to add your API’s description, logo, and name before making your API public on Rakuten RapidAPI.

Inviting Users to Consume Your API

When an API is private, there is no way for developers to know about its existence. To invite clients, collaborators or friends to utilize your API, we have created the invite functionality.

To invite a user to consume your private API, the user needs to have an account already registered on the Rakuten RapidAPI platform.

These are the steps to invite a user to your private API on Rakuten RapidAPI:

  1. Log in to the Rakuten RapidAPI Provider Dashboard
  2. Navigate to your API’s Settings tab
  3. Scroll to the bottom of the page and locate the ‘Invite Developer’ section
  4. Hit the Invite developer option
  5. In the popout modal: Search for the username for the user you would like to invite, select the user from the dropdown, and press ‘Send Invite’.

If you added someone by mistake, or you want to remove a user to have access to your API you can remove it by clicking the ‘X’ next to the username under the ‘Invited Developers’ section.