How to create an API key and use the API ?

  • Updated

In which cases should you use the API?

Some of our users need to access their plot or sensor data on a permanent basis, rather than on a one-off basis (as may be the case with a spreadsheet export (XLSX, CSV...)).

Their goal is to develop a third-party solution that consumes their data produced via Weenat and integrates it into another system.

To do this, you need to use the API and will need to generate an API key.

API keys are used to authenticate with the Weenat API.

Once authenticated, the user has access to the same scope (organisations, plots, sensors) as they have access to via the application.

The API is intended for users who have development capabilities within their organisation (company, cooperative, farm...) or for tech-savvy users who want to test or develop integrations or applications, with or without AI.

 

How do I create an API key?

Simply go to "My Account", then to "API" and click on "Create a key". 

Give it a name and the key will be generated. 

You can use up to 20 keys at the same time. This can be handy if you are running several projects in parallel or juggling multiple environments.

 

cle-api-weenat.gif 

 

Where is the API documentation?

Once the key has been created, simply access the swagger: https://dev.weenat.com/ to test it.

Finally, if you have questions about the format, quotas, limits, data model..., there is the detailed documentation: https://dev.weenat.com/v3/

 

 

What can you do with the API?

With Weenat's DEV API V3, you can develop your own application. Here are some examples of features that can be developed using the DEV API V3: 

 

 

How to use an AI and the Weenat API to develop your own applications?

Don't have developers or development skills?

In just a few minutes, using an AI (Claude.ai in the example below) and Weenat's DEV API V3, you can have a prototype or an application that meets your needs. In this example, a comparison of tensiometer data.

Provide the Open API file (YAML), the links to the Swagger and the detailed documentation to Claude and describe what you want to achieve:

 

 

Quickstart - How to get started with the API quickly?

Here is a quickstart video for all developers who would like to get started quickly with the API and run their first tests via the Swagger

 

Related to

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request