breakout-api-client

    0.18.6 • Public • Published

    An API client for the breakout api written in JS

    Usage example

    Install the dependency as follows:

    npm install --save breakout-api-client

    And use it like this:

    const BreakoutApi = require("breakout-api-client");
    
    const debug = true;
    const api = new BreakoutApi("http://localhost:8082", "client_app", "123456789", debug);
    
    async function test() {
        // Perform login for user with email and password
        // A side effect of this operation is that the returned access token
        // is saved in this instance of the class BreakoutApi, so that all following
        // requests are authenticated with the users access_token
        try {
            await api.login("sponsor@example.com", "test");
            const me = await api.getMe();
            console.log(me); // Information about the currently logged in user
        } catch (err) {
            console.log(err.message);
            console.log(err.response.data);
        }
    }
    
    test();

    Keywords

    none

    Install

    npm i breakout-api-client

    DownloadsWeekly Downloads

    6

    Version

    0.18.6

    License

    AGPL-3.0

    Unpacked Size

    19.5 kB

    Total Files

    7

    Last publish

    Collaborators

    • florianschmidt1994
    • mathiasquintero
    • dominikglandorf
    • sibbl
    • breakout-devops