Griffin API Qodex Workspace
This is a Qodex workspace including a collection covering the Griffin API. See
https://docs.griffin.com/ for more details.
Getting started
- Register for a Griffin account, if you haven't already.
- Follow our getting started with the API guide to learn how to create an API key and make simple requests.
- Install Qodex
Copy collection to your Qodex workspace
The easiest way to make our [Griffin API Collection] available within your Qodex workspace is by [forking it]
Set your API key
Once you have your API key, set it as an [environment variable] named
griffin-api-key, within your workspace.
Making requests
Each request in the Griffin collection has a [Qodex test] that runs on the response. This test will interrogate each response body and for every URL assign a corresponding [Qodex environment variable]
As an example, when making the
Index request (in the
setup folder), you'll see the response body includes an
api-key-url, among others. You should also now see a Qodex environment variable named
api-key-url with the URL as the value. We lean on this to easily 'navigate' the API from the root rather than hardcode routes and interpolate resource IDs.
Using the Qodex Collection
Within our collection you'll find three top-level folders:
Setup,
Reference, and
Guides.
Setup
Once you have your API configured, the first thing you'll want to do is run the
Setup folder. This makes a series of API requests from the
index route and populates a bunch of Qodex environment variables that you'll need to do anything useful, e.g. your
organization-url,
organization-corporations-url etc.
Reference
As a companion to our
API reference documentation, here you'll find individual requests grouped by resource.
Guides
Currently the collection has the
Onboard your customers guide. It includes the series of API calls described in our
Onboarding your Customers guide.