Information about the eSpatial API
NOTE: This is an Enterprise Feature, it is only available for users who have purchased our Complete Solution Plan.
Data Integration/API
eSpatial has a REST Data API which offers API methods which are intended to be used for the import and synchronization of data with eSpatial datasets.
As it is in API (Application Programmer Interface), it is intended for users that have an in-depth knowledge of their own system (application, database, API or other data source) and relevant technical expertise in some language that can be used to communicate with a REST API, such as Java, C#, C++, PHP, JavaScript.
Using the Data API will give fine-grained control over what is sent to eSpatial, when, and exactly what actions to take. If the Data API is suited for your organization, assistance to setup and support of this is available under our existing consultancy rates, please see our pricing page for more details on these.
Otherwise, this service is offered as is, although we will make every effort to ensure future Data API updates will be backwards compatible.
Standalone Application Which Automatically Updates eSpatial
This requires that you update a supported file (CSV, Excel, JSON, XML, HTML) on your network, and that this file will be uploaded into eSpatial either to overwrite the existing data or to be simply appended. The benefits of this option are:
- This is a simple implementation and should be straight forward to setup.
- Although there is a manual effort in it (getting the CSV file onto the network), at some stage, this process could be automated on your side. Most applications provide capabilities to export a CSV file. With the right skills it may be possible to export this automatically to a network location at regular intervals to be picked up.
- Using a scheduled task or chron-job, it is easy to automate this process.
API Limits
The eSpatial REST API is available to Enterprise account types with relevant account type limits applicable, see also: https://www.espatial.com/pricing.
If an API request is made which exceeds your limit a Bad Request error (HTTP response code 400) will be returned with detail of limit exceeded in response body and/or header.