bkper

Node.js client for Bkper REST API

Usage no npm install needed!

<script type="module">
  import bkper from 'https://cdn.skypack.dev/bkper';
</script>

README

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

1) 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

Environment Variables

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

BKPER_API_KEY=XXXX
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.

WARNING: Never upload variables to the source code repository.

Documentation