💡 The API Documentation can be found here.
💡 A sample use case using our public API can be found here.
The Environmental Data Platform’s API allows you to connect your data sensors and automatically log your data in the EDP. It allows centralized visibility to monitor calculations, trends, and limits and reduce possible errors during the manual data entry process.
Data Flow Overview
Data generated from any devices or sensors you have on your site will send that information into Logs created in the EDP. You’ll be able to view this data on your site, along with any Limits or Views that have been created.
Getting Set-up With The API
To get set up with the API, please reach out to your CSM. If you are not sure who your CSM is, please reach out to help@mapistry.com. You will also need internal IT resources who can assist in setting up the API connection.
Here’s a list of what we’ll need to kick-start the setup process:
- IT resources to build the connections and be an active part of the onboarding process
- What information would you like to see in Mapistry?
- What data points are your devices currently tracking?
- Do you have an example of the raw data you’re currently collecting?
- What sites do you want to have connected via the API?
The set-up process is different on a case-by-case basis depending on your specific needs, but once the API connection is made, you can expect to be able to:
- Review your Views
- Export your data
- Get Alerts
- Keep track of your Log status
- View your Limit Analytics Dashboards
API Tech Spec
💡 The API Documentation can be found here.
- Submission Rate Limits: Each user is limited to 100 requests per minute,
- Pagination: Some of the API endpoints return a paginated list of items. We use cursor-based pagination - each response includes information about how to fetch the next page of results.
- TSS/SSL: The API only supports secure connections to the server. Unencrypted requests will be denied with a 403 response and error message.
If an error code is returned and you are unsure how to proceed, please reach out to help@mapistry.com with information on what you tried to do, the specific error code you received, and an estimated time frame of when this action happened.
End of Article
Support
If you have any questions or need further assistance, please e-mail help@mapistry.com or call (510) 313-1422.