Quickli API Authentication Guide

Overview

Each partner is assigned a unique client secret. Users from the partner's organization must generate a secure token or use their email, depending on the authentication scopes allowed for the partner.

Steps to Authenticate

• Partner Level Client Secret

  Each partner receives a unique client secret from us. This secret identifies the partner and determines the allowed authentication scopes.

• User Authentication

  Depending on the partner's allowed authentication scopes, users can either generate a secure token or use their email. Tokens can be generated at: https://app.quickli.com.au/settings/integrations

• Construct Authorization Header

  The authorization header is constructed based on the allowed authentication scopes. It always starts with the client secret, followed by the token and/or email if applicable.

• Send Request

  The constructed authorization header is included in the API request as a Bearer token to access the scoped resources.

Authentication Scopes

Partners can have one or more of the following authentication scopes:

• token

  Requires a client secret and a user token

• email

  Requires a client secret and a user email

• token:email

  Requires a client secret, a user token, and a user email

Authorization Header Examples

Token only: Bearer clientSecret:userToken
Email only: Bearer clientSecret:user@example.com
Token and Email: Bearer clientSecret:userToken:user@example.com

Request Format

POST /api/v1/resource
Headers:
  Authorization: Bearer clientSecret:userToken
Body:
  { /* request payload */ }