@hpi-schul-cloud/nexboard-api-js

nexboard-api-js

Usage

Nexboard = require("nexboard-api-js");

nex = new Nexboard(ApiKey, UserID, Url);

params

• ApiKey = The identification key from account.
• UserId = The Id from user.
• Url= the URL of the API interface. If zero the value is set to default

functions

nex.getProjectsIDs();

retun a list of IDs from all projects.

nex.createProject(
    "Title of project" , 
    "description of project");

create an new project and return it.

nex.createBoard(
    "Title of Board" , 
    "description of Board", 
    IdOfProjectFromThisBoard);

create an new board and return it.

nex.getBoardsByProject(ProjectId));

return all boards from Project.

nex.getBoard(BoardId));

return the board object from ID.

Test

We are using contract tests with pact-js to ensure this module is compatible with the latest version of the neXboard API. Run npm run create-pacts to verify compatibility and create pacts. This will override pacts/schul-cloud-nexboard.json with the newest contracts. These generated contracts will also be used in neXboard to verify new deployments don't break this dependency.