Before you start:
You must be a part of a registered customer or team on ATLAS to use this API. Please refer to our Getting Started page for instructions on creating a customer
All teams and enterprise customers on ATLAS are assigned a unique domain. Any API calls must be made to that domain.
If you're unsure of your domain, please login from enablemyteam.com
In most cases, you will be redirected to your domain after login. However, your customer configuration might be using an external enterprise sign on. Please email our help desk at [email protected] and we will help you with your domain.
Using this API endpoint, you can interact with the following ATLAS datasets:
- Point clouds
- GIS data
- Other bespoke integration pipelines
Using this API endpoint, you can interact with the following datasets:
- Documents (PDF, Excel)
- 3D Model Formats (DGN, DWG, IFC, REVIT and more)
- 2D Drawings
An authentication token is required for every API request sent to ATLAS. ATLAS using JWT tokens which is an open standard (RFC 7519). Tokens are valid for a specific duration (configurable for your customer). Expiry time of the token can be retrieved from within the token json packet. This token must be passed in every subsequent API request. Upon expiry, user must re-login for a new token.
Here is a quick recipe to get started with ATLAS APIs
Valid requests and responses from the API will return a JSON response consistent with the API data model described in specification for each endpoint. ATLAS has a built-in asset information management system. All data extracted from unstructured, structured or 3rd party systems is described as an "asset". Users can create/update their own data model for assets using "asset_type" API endpoints. Hence, asset classes, relationships and attributes are entirely configurable by users themselves using this API.
Please see Guidance Notes for ATLAS data model for more details.
See below recipe for retrieving asset schema from ATLAS:
We have also created Guidance notes for Searching Assets using ATLAS API
Authorised users can refer to ATLAS for Rail guide to get details of more Rail specific integrations within ATLAS.
For any help, feel free to email [email protected]
Don't forget the what's next section below to continue learning a bit more about our API