Adding a pre-configured API is a 3-steps process:
To select an API to add, follow these steps:
Click on "Add an API", select the API you want to use;
After selection, click on the "Add" button.
All APIs on the Hub are pre-configured to work with the Bearer platform. So you can focus on consuming endpoints - and not on dealing with authentication, base URL, etc.
Setting up an API on Bearer is a two steps process:
Creating an account or an application on the API provider website
Providing your API credentials to Bearer
To create an OAuth application on GitHub, follow these steps:
Log in to https://github.com
Access the developer settings page and register for a new OAuth application
Fill the new application form with the following information:
Application name: My GitHub Integration
Homepage URL: https://www.yourdomain.com
Authorization callback URL: https://int.bearer.sh/v2/auth/callback
To let Bearer performs authenticated requests to the API on your behalf, you need to provide your API credentials on the Instructions page.
With the GitHub API, right after registering a new OAuth application, Github will give you the necessary
Client ID and
Client Secret credentials.
Use them on the Instructions page of the Dashboard:
You are close to the end 🙌 Let's just confirm that everything is all set.
Right from the Bearer's dashboard, on the Instructions page, you can generate a new identity by connecting yourself to an API using OAuth2 or OAuth1.
As we are trying to add the GitHub API, let's connect ourself with our GitHub account:
The OAuth authentication uses your own credentials, that you just provided before. After granting access, on success, the "Connect" button will be replaced by an
Each APIs from the Hub provides a safe endpoint to let you try in seconds that everything is well configured. Just follow the steps from the Bearer's dashboard, depending on the API clients you want to use:
You can add as much APIs as you want.
You can still add it to your Bearer account. Just follow the guide on how to add a custom API. Also feel free to reach us so that we can add this API in priority. We are adding new ones every week.
You can save multiple credentials to the same API several times using the setup component. This is pretty useful if you are looking for retrieving the credentials of your own customers (e.g. to create a marketplace of integrations on your own service).
If your test request returned an error, first look at the logs in the Logs page. You will find useful information to help you debugging. For notice, most common errors are:
the API credentials aren't the right ones;
for OAuth2 and OAuth1 APIs only:
the authentication flow doesn't use the Bearer callback URL which is :
the user identity hasn't been generated. Remind to click on the connect button to trigger the OAuth dance.