Third party APIs¶
Deprecated : removed in API Maker v4
Third party APIs and the API Maker store are deprecated. They keep working in v3 for the projects which installed bundles, and the pages of the admin panel are grouped under Deprecated Features. New projects should write the same code as custom APIs and utility classes, which the local client and Git share between projects.
A third party API is one API of a bundle published on the API Maker store : a version of the bundle is installed into the account, and its APIs answer under the account like custom APIs.
| URL | /api/third-party/<user-path>/<bundle>/<version>/<path of the API> |
| Method | the method of the API in the bundle |
| Settings | caching, encrypted payloads, access type and auth providers per API : Third party API settings |
| Hooks | pre and post hooks per API |
| Secrets | the keys the bundle needs live in the secret of the account, under the names the bundle documents |
Install a bundle¶
Utility → AM Store(under Deprecated Features on the dashboard) lists the published bundles.- Open a bundle, pick a version and click Install API Version. The npm dependencies of the version are added to the sandbox.
- The APIs appear on
API Info → Third Party API, in a tree per bundle and version, each with its method, name and path.
Use an API¶
- Test it on the API testing page (the vial icon) : headers, query params, body, response and logs, with the code of the API readable next to it.
- Call it over HTTP with the token of an API user whose group grants the bundle.
- Validate a body against the schema the bundle declares with is valid data for third party API.
- Reset its cache with reset third party API cache.
Uninstall¶
- The library dialog of the store uninstalls a version. Reverting the YAML file of the bundle in Git brings it back, with its utility classes.
