Free Trial Period: Sign up and get our Private plan three months for free. No payment details are needed.
Sign up for FREE

Shares

A common use case is to create an API share for a private API to give other users read-only access to a protected API documentation. It is also possible to share a public API with a limited set of options.

Creating an API Share

Navigate to the API you want to create an API Share for, go to the Shares page and click on Create Share.
API Share
When creating an API share you have to provide a name for the Share and enter at least the nickname or email address of one user the Share is for. It is also possible to specify dates from and until the Share is accessible. If not set, unlimited access is granted.

All users will receive an email about the shared API. The email contains a link to the API. If the user hasn't got an APITree account yet, the email includes a link to sign up for an account.
Create Share
After creating the share, an overview page is displayed with a list of all shares. All properties of a share can be edited later. If the share is deleted, all users will receive an email that the API is no longer available. Share created

My Shares

Login to your account. Make sure your email address is verified. In the left sidebar click My Shares. You will get a list of all API Shares which are available. Also expired and upcoming shares are shown. You can remove a Share at any time by clicking the Remove button next to the share. Here an example of an active API Share:

My Shares

Can't find what you're looking for?