Ticket Socket Enterprise Integration API

• Ticket Socket Enterprise Integration API
  • Installation
  • Environment Variables
  • Running the database
  • Running the app
  • Test
  • Swagger docs

API Documentation

Installation

Requirements: Docker

bash
$ npm install

Environment variables

Environment variables are required for configuration

.env files are supported at the root of this project directory

JWT_SECRET=CHANGE_ME #not used, but required because JWT auth guard is not removed
MONGODB_URI=mongodb://localhost:27030/tse-integration-api

Running the database

Create tse-integration-api DB (to match MONGODB_URI property from .env file)

Add tse-credentials collection. Record sample for Fiba database

{
    "privileges" : [
        "events",
        "check-out"
    ],
    "name" : "fiba",
    "clientToken" : "test-token",
    "v2ApiUrl" : "https://dev-sc-apne2.ticketsocket.com/development/api/v1/",
    "v2StoreFrontKey" : "pk-00ebb45464324465b50127319ea2f84a"
}

Run command:

$ docker-compose up

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov