Aviary Connector v1.0
Login to Aviary
After logging in you will be directed to main dashboard.
1. Authentication
API authentication method:
Authorization: /api/v1/auth/sign_in
This endpoint allows Aviary users to sign in with an API Key and, upon successful authentication, returns a JSON response containing data about the user's profile and data about each of the organizations that the user is a member of.
Creating a User API Key
In order to work with the Aviary API, users can generate an API Key. An API key, or application programming interface key, is a unique code that identifies and authenticates an application or user. To create an Aviary API Key, browse to your Aviary user profile. On the API Key section, click on the Generate/Regenerate API Key to reveal the one-time key. For security purposes, the key must be saved to a secure location and will not be revealed to you again. If you lose your key, you can simply regenerate a new API Key by clicking the same button.
2. Connector Actions and Tests
Action Name / Method | Collections (GET) |
|---|---|
Action Description | Allows to retrieve information about collections hosted within the Aviary platform. Specifically, it provides access to metadata and structural information about a particular collection.
|
Test Case | Retrieve collections |
Request Body Name | Parameter |
Action Name / Method | Resources (GET) |
|---|---|
Action Description | Use GET request to fetch resource data using an existing resource id.
|
Test Case | Retrieve collections |
Request Body Name | Parameter |
| Resource Id |
| Collection Id |
| Organization Id |
3. Connection Settings and Configuration
