Getting Started

The FPMA Tool Application Programming Interface (API) provide seamless access to public data from the Food and Agriculture Organization (FAO) production databases. These APIs are designed to be used both for public access and for deployment in self-hosted or cloud environments. Users can interact with these APIs via two main interfaces:

1. Swagger Interface: Access the Swagger documentation and API playground at {domain}/giews/v4/global/swagger/. This interface provides a comprehensive view of the available endpoints, allowing users to test and explore the APIs interactively. The Swagger interface is user-friendly and requires no authentication, as all the APIs are public.
2. Django Interface: The APIs can also be accessed through the Django framework at {domain}/giews/v4/global/price_module/api/v1/. This interface is structured to facilitate integration with various systems and applications.

info

For example, the FAO Production site offers access through these interfaces:

• Swagger: https://fpma.fao.org/giews/v4/global/swagger/
• Django: https://fpma.fao.org/giews/v4/global/price_module/api/v1/

Throughout this tutorial, we will demonstrate how to use these APIs to access public data efficiently. The Swagger playground is particularly useful for trying out different API endpoints without the need for login credentials, providing a practical environment for testing and experimentation.