Getting started

Tick is build as an open API which you can consume

Tick open API swagger documentation

How to consume

The API of tick is straightforward.

Authentication:

Authenticate each request by adding a request header called "token"

You authenticate with a token given which is always bound to a user which you can impersonate. you can do use one of the following methods: 1. (preferred) Provide the token in each request header with key: "token" 2. Extend the url with a querystring param providing the token. for example ?token=xyz
3. (use sparse)Provide basic authentication via request header "Authorization" where username = tenantId~username (for example: [email protected]) Beware that if using this method you are effectively logging in with each request

Tick-API is available as OpenAPI via: Tick API swagger documentation

Token lifecycle

At Login you receive everything needed such as the token, current userId, available workspaces etc.

1. At Logging in a token is generated for you to use
2. Use this token in all your requests either in a request header called "token"(preferred way) or querystring param called "token"
3. At logging out the token of this user is revoked and invalidated.

stateDiagram-v2 
  direction LR
  apiCalls: call API with token
  unAuthorized: not authorized
  tokenDiscard: Token is discarded

    [*] --> Login
    Login --> apiCalls: receive token
    apiCalls --> unAuthorized
    unAuthorized --> Logout
    apiCalls --> Logout
    Logout --> tokenDiscard

Logging out revokes the token

Usage

Tick API is build with JSON as data format