Fairmarkit API settings

From the Fairmarkit API tab, you can generate an API key and configure the Fairmarkit webhooks. The Fairmarkit API is based on Open API Specification (OAS) based on REST. The Fairmarkit API has predictable resource-oriented URLs that use standard HTTP response codes, authentication, and verbs.

Important: The Fairmarkit API tab is a configuration setting that is not automatically enabled. If you are interested in using the Fairmarkit API or have any questions about settings specific to your enterprises, contact your Fairmarkit Customer Success Representative.

See also: For more information on the Fairmarkit API and webhooks, see Fairmarkit API overview and the Fairmarkit developer portal.

Access API settings

You can access Fairmarkit API settings from the Administration screen.

1

From the menu, select Administration.

2

Select the Fairmarkit API settings tab.

Manage your API key

The Fairmarkit API requires an API key to authenticate requests. You will need to include your key in every request made to the API. The API Key must be provided in the X-FM-API-KEY HTTP request header.

Generate an API Key

1

In API Key, click the Generate button. A key will generate and display in the field.

2

Click the copy button to copy the key to your clipboard.

Generate a new API key

As needed, you can generate a new API key.

Warning: When you generate a new API key, you will deactivate any previously generated keys.

1

Click the Generate button. A message displays a warning that your previous key will be deactivated.

2

Click Generate.

Deactivate an API key

You can deactivate an API key when it is no longer needed.

1. Click the Deactivate button. A message displays a warning that any previous integrations will be lost.

2. Click Deactivate.

Configure Fairmarkit webhooks

Fairmarkit webhooks allow you to get notifications from Fairmarkit about changes to your data as they are happening. Instead of having to pull information using the Fairmarkit API, the webhook will automatically push information to your endpoint as events happen. When the event happens, a one-way data share is automatically sent to your application. For example, when a request for quote event is awarded, the RFQ_AWARDED webhook can send updated event data to your application.

See also: For more information and sample code for the Fairmarkit webhooks, see the Fairmarkit developer portal.

To create a webhook for your application, complete the following:

1. In URL for Webhook, enter the HTTP endpoint where your events will be sent. This can be up to 200 characters.

2. In Authorization Token, enter the authorization token. This field is optional unless an authorization is required to access the endpoint.