kontenbase

Kontenbase API Node.js Client

This is the Official Node JS API client/library for Kontenbase API. Visit https://kontenbase.com. More information about the product and see documentation at http://kontenbase.com/api for more technical details.

• API Documentation
• Installation
• Usage
  • User Services
    • Register
    • Login
    • Add to Role
    • Remove from Role
    • Get Profile
  • Record Services
    • Create Record
    • Update Record
    • Get Record
    • Delete Record
• Contributing

API Documentation

Please check Kontenbase API Reference.

Installation

Node.js

To install kontenbase in a node project:

npm install --save kontenbase

Kontenbase is compatible with Node 10 and above.

Usage

Configure package with your account's API key obtained from your Kontenbase Dashboard.

const KontenBaseClient = require('kontenbase')

const kontenbase = new KontenBaseClient({
  apiKey: '*******************',
})

User Services

Use kontenbase auth services for manage your user/customer

Register

await kontenbase.user.register({
  firstName: 'lucky',
  lastName: 'axl',
  email: '[e-mail]',
  password: 'strongpasswd',
  role: 'authenticated',
})

Response:
{ "token": "8868bcf9826f0****" }

Login

await kontenbase.user.login({
  email: '[e-mail]',
  password: 'strongpasswd',
})

Response:
{ "token": "8868bcf9826f0****" }

Add User To Role

await kontenbase.user.addToRole({
  userId: '605a2115a1cedf3fxxxxxxxx',
  roleName: 'authenticated',
  token: '8868bcf9826f0****',
})

Remove User From Role

await kontenbase.user.removeFromRole({
  userId: '605a2115a1cedf3fxxxxxxxx',
  token: '8868bcf9826f0****',
})

Get Profile

await kontenbase.user.getProfile()

Record Services

Initiate Record service using table prototype that has been injected with your Table Name, and userToken

const record = kontenbase.table("My Table", userToken);

Create Record

await record.createOne({
  Name: 'Axl',
  Notes: 'I Love You'
})

Response:

Get Record

await record.list()

Response: [
  {
    _id: '605a151e409d123bf33be5a9',
    Name: 'John',
    Notes: 'No Code',
  },
  {
    _id: '605a251d7b8678bf681f284e',
    Name: 'Jenny',
    Notes: 'Ready',
  },
]

Update Record

await record.updateOne(recordId, {
  Name: 'Axl',
  Notes: 'Cool'
})

Response:
{ Name: 'Axl', Notes: 'Cool' }

Delete Record

await record.deleteOne({
  id: '605a251d7b8678bf681f284e',
})

Response:

Interactive documentation

Go to https://kontenbase.com/api to see the interactive API documentation for your Kontenbase project. Once you select a project, click the "JavaScript" tab to see code snippets using Kontenbase. It'll have examples for all operations you can perform against your project using this library.