Geo Data

This article is a stub.

This article describes a technical aspect, and is mainly for advanced users.

Template:Learned

What is the API?

An API (Application Programmers Interface) is a feature in software which allows external parties to create applications to interact with the software. Where human users make use of a graphical interface, applications can send and receive data packages directly, in some form, when communicating via an API. An API is most useful to technical users, as the ability to create or configure your own software is implicitly required.

How does the API relate to the Tygron Engine?

The Tygron Engine consists of two essential components: server software and a client application. When you use the Tygron Engine installer, you actually only install the client application of the Tygron Engine. Clicking buttons to create projects, start session, place buildings, or perform other tasks, actually sends instructions to the server software, where the actual session is (or will be) hosted. The client application then receives data from the server to display to the user, graphically. The API is part of the server software, and allows a user to write their own application to send instructions and/or display data. This means that the API can be used to automate tasks, such as the generation of new projects, or the placement or buildings, and can be used to analyse the data present on the server.

The API for the Tygron Engine can be reached by appending the URL for the Tygron Engine with "/api/". For example: https://engine.tygron.com/api/

When to use the API?

The API is meant for technical users. Specifically, software developers will be able to make the best use of the API. For most users, it is recommended to use the client application. The client application has been made user-friendly, and is the preferred method of interacting with the Tygron Engine in most use-cases.

There are a number of more technical tasks which do require the API to be used, and which expand the usability of the Tygron Engine greatly. Tasks for which the API can be used include:

• Automated data analysis, such as building density analysis during a session.
• Automated interactions, such as measures activated under specific circumstances.
• (Automated) data entry from a database or program into the Tygron Engine, such as possible function types.
• Automated data extraction, such as taking the spatial results from a session to use as input for other data analysis programs.
• API indicators, which allow showing the results of a complex calculation as an indicator score.

Structure

The API is structured in such a way that from the root url of the API, it is possible to reach all parts of the API, provided you have sufficient credentials. The first section is related to data and operations related to the Tygron Engine itself, such as user and project management. It also provides access to a second section, which relates to specific projects currently running on the server. The credentials strictly required for these sections differ.