Ctf_scoreboard_api NPM

ctf_scoreboard_api

CtfScoreboardApi - JavaScript client for ctf_scoreboard_api Manage the CTF scoreboard of the BFH ITSEC laboratory This SDK is automatically generated by the Swagger Codegen project:

API version: 1.1.0
Package version: 1.1.0
Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit http://iam1.nslab.ch

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install ctf_scoreboard_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var CtfScoreboardApi = require('ctf_scoreboard_api');

var api = new CtfScoreboardApi.ChallengeApi()

var body = new CtfScoreboardApi.Challenge(); // {Challenge} Challenge object to be added to the scoreboard


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addChallenge(body, callback);

Documentation for API Endpoints

All URIs are relative to https://localhost/v1

Class	Method	HTTP request	Description
CtfScoreboardApi.ChallengeApi	addChallenge	POST /challenge	add a challenge
CtfScoreboardApi.ChallengeApi	deleteChallenge	DELETE /challenge/{id}	Delete challenge
CtfScoreboardApi.ChallengeApi	getAllChallenges	GET /challenge/all	Get all challenge
CtfScoreboardApi.ChallengeApi	getChallengeById	GET /challenge/{id}	Get challenge
CtfScoreboardApi.ChallengeApi	submitFlag	POST /challenge/submitflag	Submit a flag
CtfScoreboardApi.ChallengeApi	updateChallenge	PUT /challenge/{id}	Updated challenge
CtfScoreboardApi.ScoreApi	getScoreBoard	GET /scoreboard	add a score
CtfScoreboardApi.StudentApi	addStudent	POST /register	register a new student
CtfScoreboardApi.StudentApi	deleteStudent	DELETE /student/{id}	Delete student
CtfScoreboardApi.StudentApi	getAllStudents	GET /student/all	All students
CtfScoreboardApi.StudentApi	getScorelist	GET /student/me/scorelist	Own detailed score list
CtfScoreboardApi.StudentApi	getSelfStudent	GET /student/me	Own data
CtfScoreboardApi.StudentApi	getUserById	GET /student/{id}	Get user by id
CtfScoreboardApi.StudentApi	updateStudent	PUT /student/{id}	Updated student

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

superagent

@everything-registry/sub-chunk-1423

1.1.0

7 years ago

1.0.0

7 years ago