Summary

The purpose of this document is to guide a partner through building integrations with the Fieldguide API and Fieldguide Webhooks.

Fieldguide API

Accessing the API

The Fieldguide API is available in two environments: staging and production. Staging can be considered production-like and can be used for partner integration development.

The OpenAPI documentation is available for both environments.

Authentication

The Fieldguide API uses authorization tokens to identify which Fieldguide user the request is issued on behalf of. The token should be sent as the request’s Authorization header and prefixed with the Bearer designation.

So if the user’s authorization token is fg_us_620c632a9acf23ef902794b7cf299376, the request should be issued with the following header:

Authorization: Bearer fg_us_620c632a9acf23ef902794b7cf299376

There are two types of authorization tokens that the Fieldguide API accepts: user-provisioned API tokens and OAuth tokens.

User-Provisioned API Tokens

To provision a user token, the user needs to login to their Fieldguide account and go to their profile.

For Firm users…

1. Click your user’s initials to open the user menu.
2. Click My Profile and then Integrations from the sidebar menu.
3. Click the Add custom integration button to generate an API token.

For Client users…

1. Click your user’s initials to open the user menu.
2. Click My Profile and then API Tokens from the sidebar menu.
3. Click the Create API token button to generate an API token.