API Explorer (Beta)

The API Explorer is a new feature in beta with limited access. You can request access by contacting our team.

What is the API Explorer? #

The API Explorer allows you to test an API in real-world conditions directly from its documentation. It facilitates API discovery by enabling you to try out specific API calls on any server listed in your definition file. It helps you get started quickly without a testing environment or share a specific use case for discovery, support, or debugging purposes.

How to use the API Explorer? #

The API Explorer is accessible at any time via a button at the top of your documentation (and remains visible as you scroll). Each operation also features a button that opens the API Explorer for that specific operation.

If you haven’t opened the API Explorer from a specific operation, you can select one from the corresponding menu.

We identify the required fields directly from the definition file, making it easier for you to fill out the request, detecting whether it’s a boolean, date, etc. Fill in the expected information to execute the request and receive a response.

Sharing #

It’s possible to share a request setup, which is useful for showing an example in a demo or for support purposes. The share button generates a URL that includes the pre-filled request parameters.

This URL will never share your authentication parameters or the response.

If the API documentation has been updated after the share URL was generated, the Explorer will notify you that the pre-filled fields may have changed and display a link to the API changelog for a more detailed review of the changes.

The curl commands generated when filling out the form are copyable.

Security #

To ensure maximum security and confidentiality of requests, Bump.sh does not collect or store any confidential data during API Explorer use.

Proxy #

To ensure optimal compatibility and total confidentiality, we chose to let the user’s browser process the requests rather than our main servers. Despite the obvious advantages, requests sent from a browser are sometimes poorly received by servers and result in what are known as CORS errors.

To avoid this situation, we created our own proxy, designed to ensure that requests sent from a browser are processed without error by an API’s servers, all while maintaining confidentiality and security: cors toujours.

This proxy is hosted outside our infrastructure to ensure data security. Its open-source code will soon be made available to the community.

Authentication #

We support authentication for APIs that require prior authentication. Two options are available: via HTTP (Basic/Bearer) or via API keys.

When sharing a request, this authentication information is never transmitted.

Known Limitations of the Beta #

The API Explorer is currently in closed beta. As such, not all features are yet available. Here is a non-exhaustive list of its current limitations: