bkper
TypeScript icon, indicating that this package has built-in type declarations

2.7.1 • Public • Published

npm

Bkper Node.js client provides a simple and secure way to access the Bkper REST API on Node.js

It also provide a command line utility to create and update Bkper Apps and Bots

Instalation

Add the package:

npm i -S bkper

or

yarn add bkper

Commands

  • login - Logs the user in. Saves the client credentials to a ~/.bkper-credentials.json file.
  • logout - Logs out the user by deleting client credentials.
  • app -c - Create a new App based on ./bkperapp.json file.
  • app -u - Update an existing App based on ./bkperapp.json file.

Examples

npm bkper login
yarn bkper login

Environment Variables

The following environment variable is necessary in order to communicate with the Bkper REST API:

BKPER_API_KEY=XXXX

The app command also uses the following variables in order to perform App create/update operations:

BKPER_CLIENT_SECRET=YYYY
BKPER_USER_EMAILS="someone@gmail.com anotherone@altrostat.com"
BKPER_DEVELOPER_EMAIL=somedeveloer@mycompany.com

You can add a .env file at the root of your project with those variables and bkper will automatically load from it. Follow these steps in order to configure a valid Bkper API key.

WARNING: Never upload variables to the source code repository.

Documentation

Readme

Keywords

none

Package Sidebar

Install

npm i bkper

Weekly Downloads

33

Version

2.7.1

License

Apache-2.0

Unpacked Size

230 kB

Total Files

42

Last publish

Collaborators

  • maelcaldas
  • victordrumond