Imago API
Imago is a cloud-based solution for automatically cataloguing and managing your geoscience imagery to enable quicker and easier ways to validate data, models, and decisions with drill-core photographs. The Imago API enables seamless integration with geoscience imagery by allowing connected applications to upload, stream, and retrieve images on demand.
There are two ways to interface with Imago:
- Imago API enables deep integration into Imago through a standard REST API interface. Best suited for data migration scripts or applications looking to stream geoscience images.
- Portal deep linking uses well-formed URLs to open the Imago portal inside a web browser directly to a known hole or sample name/id at a known depth. Best suited for light touch integrations where authentication is handled by the Imago web portal.
Learn how to generate deep links to the Imago Portal
Authentication
Service Accounts
Integrations with the Imago API require a service account in order to obtain a session token for making authenticated calls to the Imago API. Service accounts are not linked to a specific user but represent an application or integration. Service accounts can be requested through MySeequent support request providing the following information:
- Application/integration name
- Primary contact email for maintaining the integration
Session tokens
A session token can be obtained from the /session endpoint providing the username and password for your service account. Session tokens are valid for 24hrs. Requests to all other API endpoints require a session token to be provided in the Authorization header in the HTTP request using the Bearer token pattern.
- Authorization Bearer {token}
Imago Data Hierarchy
The Imago data structure is customisable to each customer instance, so it is important to understand the components of the data hierarchy used to catalogue stored images and associated data. The Imago help site provides a good reference of the data hierarchy back to the Imago user interface.
| Level | Description | Example |
|---|---|---|
| Workspaces | A Workspace represents a site, region or project. User permissions are set to the Workspace. | Chile Exploration |
| Datasets | Datasets group collections/drillholes into a set often representing a local area and/or activity. | Pampa Maria, Mia Culpa |
| Collections | A collection represents all images for a single location, object or activity. Typically a collection represents a single drillhole and the name will match a Hole ID. Collections may also represent a sample location | DH001, DH002, LH101 |
| Imagery Types | Describes a logical table of interval or point data normally representing a single activity. Data within an Imagery Type must exist on a unique interval. | Core Trays, Hand Samples, Drone Flyover, Maps |
| Imagery | An imagery interval represents a single interval of data for an imagery type. All data in Imago (images or attribute data) must belong to an imagery. | 0m - 3.5m, 3.5m - 7.8m |
| Image Types | Each image is stored against an imagery interval and identified by its image type. | Wet, Dry (for core trays) Shift Start, Shift End (for drill rigs) |
| Attribute Definitions | Attribute definitions represent additional columns of attribute data associated with an imagery interval. | Box number, RQD, Fracture count, colour |
User's Context
A user's context is a description of the workspaces, datasets, imagery types and image types that are accessible to them. This description provides named keys that are used through the API to reference different information. In Imago, every piece of data (i.e. workspaces, imagery, etc...) is identified using named keys (e.g. workspace name, dataset name, etc...).
