Authentication

The Gophr V2 Commercial API implements authentication through API Keys. You need to include the key in a the API-KEY header for all requests.

To create an API key, simply log in to your Gophr account. Navigate to the Developer's Hub section, which can be found under your profile picture, and click on the "API Keys" link.

Within this section, you can generate a new API key and set other configuration options associated with the API.

Once you have your API key, authenticated requests can be made by adding the API-KEY header to your request.

As an example, to make an authenticated request to the GET https://api-sandbox.gophr.com/v2-commercial-api/jobs/20220607-082838-8c020adae3835f84 endpoint with an api key equal to sand-2a7df6bd-8ed3-48ad-b801-05093a866e66 you could do the following:

curl --request GET \
  --url https://api-sandbox.gophr.com/v2-commercial-api/jobs/20220607-082838-8c020adae3835f84 \
  --header 'API-KEY: sand-2a7df6bd-8ed3-48ad-b801-05093a866e66' \
  --header 'Content-Type: application/json'