API Overview
An API (Application Programming Interface), can be thought of as a connection between computer programs, offering a service to other pieces of software. They work by sending requests for information from a web application or web server and receiving a response.
Based on simple REST principles, the &Wider Web API endpoints return JSON data about working conditions reported in various sites and survey cycles, directly from the &Wider data stores. &Wider’s Web API is designed to provide our clients with access to their data for reuse or integration into their own systems. The base URI for all API requests is
https://beta.api.andwider.com/v1/reports
Common terms
| TERM | MEANING |
|---|---|
| Survey Cycle | The activity of collecting data from a particular site at a specific point in time using a particular survey (set of indicators). This usually happens 2-4 times a year on a site. |
| Site | A workplace made up of workers (the survey participants). This can be a farm, a factory etc. |
| Indicator | A question asked as part of a survey cycle survey. |
| Survey Template Type | The type of survey a survey cycle is part of e.g. Productivity, Working Conditions, COVID-19, Forensic. |
Authentication
&Wider has provided each client administrator user with authentication credentials, namely their Organisation ID and Auth Token, via the My Profile section of the &Wider Direct Worker Reporting platform. These credentials are used as authentication to retrieve data by hitting API endpoints.
To find your credentials:
- Log in to the &Wider Direct Worker Reporting platform: https://dashboard.andwider.com/Login
- Navigate to your username on the top right corner of the dashboard, click on the dropdown and click on My Profile.
- Find your Client Id and Auth Token under API Credentials.
- Click SHOW to view your Auth Token.
- Use your credentials to authenticate your API requests.
Remember that your authentication credentials allow you access to very sensitive data, so be sure to keep them secure!