Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    apiman-admin-clientpublic

    apiman-admin-client

    Node.js client for the Apiman admin API.

    Build Status Coverage Status

    This package provides a Node.js client for the Apiman REST services.

    Node.js 4, 5, 6

    NOTICE

    This project is no longer being actively maintained.

    For more information please read:

    http://www.apiman.io/blog/apiman/3scale/2016/06/22/redhat-3scale-apiman.html

    http://www.apiman.io/blog/apiman/3scale/2016/08/19/3scale-apiman-part2.html

    Contributing

    Please read the contributing guide

    Installation

    npm install apiman-admin-client -S
    

    Usage

    const apiman = require('apiman-admin-client');
    
    const options = {
      'baseUrl': 'http://localhost:8080',
      'username': 'admin',
      'password': 'admin123!'
    };
    
    apiman.status(options)
    .then(x => console.log(x))
    .catch(e => console.log(e));
    
    apiman.exportData(options)
    .then(x => console.log(x))
    .catch(e => console.log(e));
    
    apiman.gateways(options)
    .then(x => console.log(x))
    .catch(e => console.log(e));
    

    You can use to

    • Verify the Apiman status.
    • Import / export the Apiman configuration data.
    • List, add, delete gateways.
    • List all the permissions and permissions by user.
    • List, add, delete plugins.
    • List and delete roles.
    • List and delete policy definitions.
    • Get informations (APIs, Clients, etc..) about the current authenticated user.
    • Update email and full name of the current authenticated user.
    • Get, add, delete an organization.
    • Get informations (APIs, Clients, etc..) about specific user.
    • Update email and full name for a specific user.

    API Documentation

    http://bucharest-gold.github.io/apiman-admin-client/

    If you have the github rights to do it, you can publish the API documentation by running ./scripts/publish-docs.sh. This script will generate the documentation, then clone this repository into a temporary directory, checkout the gh-pages branch and update it with the newly generated documentation.

    install

    npm i apiman-admin-client

    Downloadslast 7 days

    1

    version

    0.7.0

    license

    Apache-2.0

    repository

    github.com

    last publish

    collaborators

    • avatar
    • avatar
    • avatar
    • avatar