Implementation documentation

Page / - last modified by Robert Jan Daams on 2025/02/04 11:12

Implementation documentation

last modified by Robert Jan Daams

on 2025/02/04 11:12

Table of Contents

Overview

Compatibility

API testing tools

Contents

Overview

Compatibility

API testing tools

Overview

This space contains all information regarding TerraIndex that could be useful for third parties.

For external software that tries to insert or export data from the TerraIndex database, through an API.
There is also a section that describes the lab communication and setting up the connection between a lab and TerraIndex.

After pushing the data into the database, the ID’s are auto incremented. Based on the pushes ProjectCode, you can retreive the actual assigned ProjectID.
It’s possible to search your inserted project with the REST function, just fille the searchfilter of the: GetProjectsJSON API call.
Setting up a Webservice connection for project exports
It’s possible this will return in multiple results, because a wildcard search is automatically applied. So make sure, in case of multiple results, you perform search on exact match inside the results.

Compatibility

In the past we have hosted several implementations of our API's; ASMX, SVC and REST.

We highly encourage you to connect with our REST API's, as older implementations will not be supported forever.

API testing tools

We generally recommend to test our API calls in a third part API testing tool first.

This provides insights into the workings of the API, without having to start coding right away. This also ensures any bugs in code do not interfere with the actual API call.

Our favorite API testing tools:

Postman (https://www.postman.com/)

Insomnia (https://insomnia.rest/)