Welcome

1 What is the Gestal Web API?

The Gestal API was designed to allow its customers to share their herd and feed intake data to a 3rd party software of their choice.

As the leading sow feeding system manufacturer, and through the many requests of its customers, Gestal felt the need to establish a web platform to lend a hand in reducing double data entry.

The Gestal Web API is basically an online database made available to 3rd party software companies, where they can store their data and get Gestal data. To do so, those companies use the platform detailed in the following documentation.

1 Technically speaking

Designed around REST (opens new window) and HATEOAS (opens new window) principles, our Web API is a collection of resource-oriented URIs. Each method has a series of arguments informing the execution of your intentions. Web API use standard HTTP features such as HTTP authentication and verbs widely supported by off-the-shelf HTTP client. Cross origin resource sharing (opens new window) and Content Security Policy (opens new window) are supported out-of-the-box too.

3 Terminology

Integrator

An Integrator is yourself or your company, as a software vendor or provider.

An integrator will identify itself using an integration and gain access to sites data through installations.

Tenant

A tenant is an organization (a company, a group, etc.) owned by a Gestal customer that we have in common with the integrator.

A tenant can own multiple sites, to which is associated data that they can share.

4 Endpoints

The Web API is globally available at :

https://api.gestal.cloud

It contains a multitude of endpoints to allow the sharing of various resources. For example, the following will let you obtain sow data.

https://api.gestal.cloud/integration/sows

Security

Please note that HTTPS (opens new window) and TLS (opens new window) are mandatory to access the API.