The instructions for getting an API key vary depending on which software partner you're integrating with.
API keys for direct integrations
For direct integrations from our partners, you can generate the API key (also known as an access token) in your Faire portal:
- Select Settings from the left side of your portal.
- Choose Integrations.
- Locate the integration partner from the options listed under the Direct integrations section and select the option you're looking to connect.
- Select Generate API key on the right side of the page.
API keys for custom integrations
If your team has the technical resources to build a custom integration, you'll need to generate an API token after your app has been built.
Once your app is built, you can generate the API key (also known as an access token) in your Faire portal:
- Select Settings from the left side of your portal.
- Choose Integrations.
- Scroll to the bottom of the page and click 'Have an unpublished integration?'
- Enter your APA token from your app and click 'Continue'.
- Your token will be generated.
Please note that custom integrations do not need to be 'Published' to be used.