Options
All
  • Public
  • Public/Protected
  • All
Menu

Qminder

Qminder API

The Qminder Javascript API library, supporting both Node.js (from 5.12.0) and browsers.

The API is written in Typescript and provides Typescript declaration files alongside the Javascript code.

Including in your project

This package is set up in a way that you should be able to simply use the following code to include Qminder API in your project:

var Qminder = require('qminder-api');

Alternatively, using ES6 import syntax:

import * as Qminder from 'qminder-api';

Setting up

Before starting to use API methods, it's necessary to provide your API key to the Qminder API.

The API key can be found in Qminder Dashboard under Account Setup.

// This line of code needs to be before any other API calls, otherwise you get an error!
Qminder.setKey('COPIED_API_KEY_GOES_HERE');

Using the API

The functionality of Qminder API is grouped under different Services. For example, to work with visitors in the Qminder queue, you should use Qminder.tickets.

Qminder API services are built based on Promises. This means that Qminder API can be used with await keywords in modern Javascript and .then() callbacks in ES5.

Unless specifically mentioned otherwise, the API code examples are written using modern Javascript (ES2015) standards. To write code according to modern JS standards, use latest versions of Node.js, or in the browser, compile to an older version of Javascript.

Here's a list of things you can do with the Qminder API:

  • Qminder.devices: List and manage Apple TVs attached to a location.
  • Qminder.events: Listen to realtime events of your location and perform actions when they occur.
  • Qminder.lines: List, create or remove lines in a location.
  • Qminder.locations: Get information about the current location.
  • Qminder.tickets: Query visitor data, search for visitors, modify visitor properties, put them back in the queue, automatically label your visitors and more.
  • Qminder.users: Create and manage users, their permissions and user information.
  • Qminder.webhooks: Create and remove webhooks.

Example

An example Web project has been included under examples/list_of_locations.

Another example for Node.js has been included in examples/search-tickets.js.

Some example GraphQL queries have been included in examples/graphql.

Generated using TypeDoc