Skip to content

Getting started

This walkthrough takes you from “I have nothing” to a working GET against the Quiddly API of the tenant you’re reading this on.

Prerequisites

Section titled “Prerequisites”
  • A Quiddly tenant. If you don’t have one yet, contact your Quiddly account manager. Tenants are provisioned by Quiddly; self-service signup is not supported.
  • A service account in that tenant. Contact Quiddly support to have one provisioned. A SYSTEM role service account can manage the whole tenant and all of its clients with a single token; a client-scoped account is limited to one client’s data. Self-service creation of service-account tokens is on the roadmap.

Steps

Section titled “Steps”

  1. Get a service account.

    Service accounts are non-interactive users that integrations authenticate as. Ask Quiddly support to provision one and tell you its email (name@clientId.urlAlias.urlDomain); they will give you its first token.

  2. Generate or rotate the token (once you have an account with the GenerateTokenServiceAccount right):

    Terminal window
    curl -X PUT "https://$HOST/service-accounts/$SERVICE_ACCOUNT_EMAIL/generate-token" \
      -H "Authorization: Bearer $JWT"

    The response is {"tokenType": "Bearer", "idToken": "..."}. The JWT is an HS256 bearer token issued by Quiddly. It has no expiry and stays valid until the service account secret is rotated.

  3. Call the API.

    Terminal window
    curl "https://$HOST/instance-providers/default" \
      -H "Authorization: Bearer $ID_TOKEN"

    A 200 response means you’re integrated. Anything else - check the Authentication reference.

Next

Section titled “Next”