Apiary offers a way for 3rd party applications and partners to integrate with its services and tools.
When your organisation have specific needs or your application can benefit from connecting with Apiary, you can use Apiary’s Integration API - enterprise-integrations.apiary.io.
This functionality is available only for team API Projects.
Through Integration API, you can request details about team projects saved in Apiary. Integration API also adds few other features on top.
API Description Document management platform
GitHub Integration, API Blueprint and Swagger style guide validations and API testing makes Apiary perfect as a source of truth for API Description Documents. Integration API allows you to sync current state of API Projects with your application.
When you request details about API Project, you will also get back details on how to embed API Project on your domain. Integration API response contains short-lived and scoped token for embedding specific project so it’s suitable even for public facing websites and portals.
On-demand Mock Server
Mock Server design is based upon Mock Server used in Apiary.io application and is documented in Apiary Help: Mock Server with few additions and changes in behavior.
Mock Server URL can be obtained by requesting detail of an API Project. Mock Server URLs will have different hash as an identifier. Mock server URL is available without any other additional steps. Endpoints described in API Description Document are available for requests.
Mock Server URL served through Integration API is amnesiac. Server is not recording request nor response payload or headers.
How to get access
Registration of OAuth apps is not currently opened to public. You can request registration as an OAuth Client for our OAuth at firstname.lastname@example.org. After that, we will securely (using PGP - please have one ready for your email address) exchange OAuth client ID and Secret, giving you access to our API.
In general, your OAuth flow should look like so:
- acquire user’s
authorization_codeby redirecting user to an OAuth authorize page
- exchange this
access_tokento access user’s resources
refresh_tokento get fresh
access_tokenwhen current one expires (expiration date is readable, as all tokens are JWT)