Chapter 7 API

An Application Programming Interface (API) enables different software or services to communicate with one another using a set of definitions and protocols. The CWD Data Warehouse provides an API to allow Provider services (such as a wildlife agency’s internal database) to access, create, and edit Provider data in the Warehouse. The API can be a powerful tool for integrating separate systems and creating efficient workflows. Providers may also find the API useful for creating or updating large volumes of Provider data, which may be more efficient or more functional for creating, editing, and managing Provider data through the user interface.

Using an API requires specialized knowledge and software. If integration with internal Provider systems is desired, it is likely that the Provider will need to work with its IT staff to take advantage of this feature.

7.1 API Documentation

The CWD Data Warehouse API documentation is available only to authenticated users. A direct link to API Resources is provided in the user interface main menu under the Documentation section.

7.2 Security

The API requires authentication using an API Key. The API Key must be provided with API requests via the X-API-Key HTTP header. The application does not currently support CORS, so browser-based applications hosted on separate domains are not supported.

7.2.1 How to Generate an API Key

A Provider Administrator may create one or more API keys. As a Provider Administrator, first create a new user. In the Create User interface, give that user appropriate roles based on the external application’s needs and click the button to generate an API key. A password should not be set for the user.