Skip to content

Programmatic Client for VEX Tournament Manager's web interface

Notifications You must be signed in to change notification settings

brenapp/vex-tm-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tournament Manager API

This package is a client library for the Tournament Manager API

  • Automatically manages authorization process, and ensures a valid bearer token is present for every request

  • Supports the full API surface

  • Strongly typed

  • Does not throw exceptions, which is very useful for preventing crashes in applications.

  • Easy to use

Developing An Integration

Developers need to obtain credentials from DWAB to create integrations.

Example Usage

See examples/basic.ts for an example of basic functionality.

import { Client, FieldsetQueueSkillsType, MatchRound } from "vex-tm-client";
import authorization from "./credentials.json";

const client = new Client({
  address: "https://localhost",
  authorization: {
    client_id: authorization.client_id,
    client_secret: authorization.client_secret,
    grant_type: "client_credentials",
    expiration_date: authorization.expiration_date,