Eagle.io (Source)
Extract instrument and processor node data from Eagle.io’s API.
Setup Instructions
1. Prerequisites
Before you can set up your integration in IMSURGE, you’ll need to create a new API key from Eagle.io.
The API key must have at least Workspace access level and Read Only permission. This key will be required when creating the Credentials.
You can go directly to the API key screen, or navigate manually:
- Login to your Eagle.io account.
- In the top-right corner, click your username and select Account Settings.
- Under Account Settings, click the Security tab in the left navigation.
- Select the API Keys tab on the right.
Once on the API Keys screen:
- Click Add API key.
- Set Access Level to
Workspaceand Permission toRead Only. - Click Save.
Your new API key will appear in the first box of the form. Be sure to copy and save this value for later use. If you forget to copy it, you can click Edit on your key to view it again.
2. Creating the Credentials
When adding your Eagle.io source integration, you will be prompted to either create a new set of Credentials or select an existing one. To create the Credentials you need the following information:
- Eagle.io API Key – The API key from the prerequisites step, required to access the Eagle.io API.
3. Creating the Integration
Since Eagle.io nodes can be organized to the user’s preference, navigating the full file tree is slightly different from the user interface. In IMSURGE’s integration setup page:
- Workspace – Your account workspace in Eagle.io.
- Location – The node that your data source is attached to.
- Data Source – The node you want to collect data from.
Concerns & Limitations
- Eagle.io Node Structure – API requests are made automatically during setup, but folders are hidden from view. Nested values are shown instead. When selecting a workspace, all locations are displayed. When picking a location, all valid data sources are shown. This ignores any subfolder organization in your Eagle.io environment and may cause issues if multiple nodes share the same name.
- API Rate Limits – Eagle.io imposes API rate limits per key. To avoid issues, select a polling rate that matches your project requirements without exceeding this limit.
Reference
Tips
Because IMSURGE allows you to search for locations and data sources, it’s recommended that you use unique names for your project and data source nodes to avoid confusion during setup.
When choosing a polling rate, consider the rate at which data is imported into Eagle.io, even for
Processornodes. If your data source only receives or calculates data every 6 hours, set your pipeline polling rate to match it for optimal performance.