WINDA API

API is the acronym for Application Programming Interface, which is a software intermediary that allows two applications to talk to each other. Each time you use an app like Facebook, send an instant message, or check the weather on your phone, you’re using an API.

When you use an application on your mobile phone or a desktop, the application connects to the Internet and sends data to a server. The server then retrieves that data, interprets it, performs the necessary actions and sends it back to your device. The application then interprets that data and presents you with the information you wanted in a readable way. This is what an API is - all of this happens via API.

The WINDA API allows training providers, employers and other users to access relevant data in a similar way, such as to retrieve information from the database using WINDA IDs. Instead of logging directly onto WINDA via a conventional browser, the API can connect your own software - for example a learning management system - directly to the database.

Both training providers and organisation users (for example employers), can conduct searches via the WINDA API. This allows organisations to automate integration of eligibility checks into their systems, for example checking if a WINDA ID on a personnel profile has a valid GWO Training Record.

Training providers can upload and purchase uploads via the WINDA API. This allows training providers to automate integration with WINDA by providing APIs for the following functions:

1. List uploads
2. Purchase uploads
3. Discard upload
4. Create upload
5. Download upload error file
6. Search

Please note that as of 2025-02-14 the WINDA API gateway has been updated, and the documentation has been updated to reflect this.

Included below are:

WINDA API - Documentation - A technical reference manual on how to use the WINDA API

WINDA API - Migration Guide - A guide for existing WINDA API consumers, who need to migrate to new gateway

WINDA API - Postman Guide - A quick guide on how to use Postman to access the WINDA API

WINDA API - JSON collections for Access Tokens for use with Postman

WINDA API - JSON collections for Endpoints for use with Postman

To use the WINDA API, please download and study the WINDA API Documentation. Contact GWO at info@globalwindsafety.org using the template from the WINDA API Documentation to enable access to WINDA API Test to verify your solution. Once tested and shown working, you can request GWO to enable access to WINDA API Prod.

‍