Ecosuite Project Data API

Ecosulte's Project Data API is designed and specified with OpenAPI. The Ecosuite OpenAPI is simple to use when leveraging the provided OpenAPI definitions. You can download them using this link.

1. Downloading the OpenAPI definition allows us to generate bindings for our language and environment of choice. The definition file is available publicly, and can be downloaded either in your browser or in the command line:

wget https://openapi.ecosuite.io/openapi.yml

1. Using the definition can be accomplished by using openapi-generator-cli. Let's download the tool and install a stable version:

npm install @openapitools/openapi-generator-cli -g
openapi-generator-cli version-manager set 5.3.0

1. Generating bindings is done by specifying our generator of choice. Let's use the default Python generator as an example:

npx @openapitools/openapi-generator-cli generate -i openapi.yml -g python -o .

Now it's as simple as using the generated classes and functions to interact with the API.

Python develpers with ecosuite accounts, we have working sample code to get you going quickly here: https://github.com/ecosuite/ecosuite-python