Skip to main content

Developer apps

Developer apps is where your company registers the software it builds on the Qik API. Each app signs your people in with Qik Office and calls the Qik API on their behalf — every person chooses whether to allow it. Register one app per integration, so each asks only for the scopes it needs. Company owners and admins manage developer apps.

Endpoints, scopes and the sign-in flow are in the Qik API docs.

How to create an app​

  1. Open Company settings › Developer apps and select Create app.
  2. Under About the app, enter the App name and a Description. Both are shown to your members on the permission screen.
  3. Under App type, choose where your code runs:
    • Server app — runs on your server and keeps a client secret there.
    • Browser or mobile app — runs on a device, so it gets no secret and signs in with PKCE.
  4. Under Redirect URIs, enter where Qik Office sends people back after they allow the app. Select Add redirect URI for more. Each must match exactly, including scheme, port and any trailing slash — HTTPS only, or http://localhost while you are developing.
  5. Under Permissions this app may ask for, select the scopes the app needs. Some scopes are marked Sensitive — ask for those only when the app needs them. Each person approves these for their own data.
  6. Select Create app.
  7. Copy the Client ID and Client secret from the dialog and store the secret securely. For your protection it is shown only this once.
note

The app type is set when the app is created and stays fixed from then on.

Scopes​

Apps can ask for profile, email, rooms.read, rooms.write, room_members.write, workspaces.read, workspaces.write, messages.read, messages.write, meetings.read, transcripts.read, schedules.read, schedules.write, sprints.read, sprints.write, todos.read, todos.write, time.read, qik.read and qik.write. See the Scope reference in the API docs for what each one allows.

How to manage an app​

Select an app in the list to open it. It has three tabs:

  • Settings — edit the name, description, redirect URIs and scopes, then select Save changes.
  • Credentials — the Client ID (safe to embed in your app) and, for server apps, Rotate secret. Rotating breaks every running copy of the app until you deploy the new secret.
  • People — the members who have allowed the app to act for them. Removing someone cuts the app off from their account at once, and the app keeps working for everyone else.

At the bottom of Settings:

  • Turn off — refuses every request from the app until you select Turn on. No new credentials are needed.
  • Delete — removes the app. Everyone who allowed it loses access immediately, and its client ID and secret stop working. This can't be undone.

In the list, an app that's turned off shows Off, and an app verified by Qik shows Verified.

info

Your company can register up to 25 apps. Members can allow them while Third-party apps (Qik API) is on in Apps & Integrations.