๐ขGet Going
Starting off fast or starting off slow, we know people like to go about things in different ways. So you choose what works best for you!
๐ Authentication Method
To ensure secure access, Gathr uses Bearer Token Authentication. This means every API request must include:
A Bearer Token in the Authorization header (
authToken
)The
tenantId
, which is included as part of the URL path
๐ Base URL Format: {{environmentUrl}}/{{tenantId}}/api/v1
๐งพ Required Header: Bearer Token {{authToken}}
๐ง Interacting with our APIs
Not everyone can visualize the perfect flow just by reading documentation โ and thatโs okay. The best way to get started is by using our official Postman Collection.
To access the Gathr API, simply import the collection into Postman:
Already have Postman installed, great โ just click Run in Postman for Mac or Run in Postman for Windows.
Not installed, no problem โ you can Run in Postman for Web on the latest versions of Chrome, Firefox, or Edge.
Note: When using the Postman collection, make sure you've set both the authToken
in the environment variables under Authorization and tenantId
as part of the base URL.
๐ซ Receiving your API credentials
API credentials (authToken
and tenantId
) will only be issued once their is a commercial or UAT agreement has been finalised. These credentials are sent via separate secure channels as a security precaution.
If you need help authenticating or setting up your environment, feel free to reach out to us at support@finch-technologies.com, or log a request via our Help Centre.
Last updated