@blockv/sdk

BLOCKv SDK for JavaScript

This is the official BLOCKv Web SDK. It allows you to easily integrate your own web apps into the BLOCKv Platform.

Prerequisite: Request an App ID

If you have not already done so, please request an App ID using the developer access page.

Open the developer access page Fill out the registration form with your company and project details Submit the form for review The BLOCKv team will review your registration request, and if successful, send through your App ID. You will need this App ID to run the endpoints explored in the examples below.

Installation

Install from npm

npm install @blockv/sdk

Use from the browser

<script src="https://npmcdn.com/@blockv/sdk/dist/blockv-sdk.min.js"></script>

In Node.js

var Blockv = require('@blockv/sdk')

ES6 & ES7

import Blockv from '@blockv/sdk'

Getting Started

Before running any of the web API's you need to initialise the BlockV application, You can do so but putting the following code in your opening script tag.

The SDK supports multiple instances of Blockv to be initialised.

IMPORTANT NOTE:

The prefix attribute is critical if you are using multiple instances with the same appID.

Leaving the prefix out will force the sdk to use the appID as the prefix for any stored data, Using multiple instance with the same appID and the prefix omitted will result in data override.

It is recommended that in the case of multiple instances, You use a prefix so that each instance is unique and utilizes its own unique store.

let bv = new Blockv({
      "appID" : {{APPID}},
      "server" : "https://api.blockv.io/",
      "websocketAddress" : "wss://ws.blockv.io",
      "prefix" : "blockv"
    });

The prefix attribute in the initialization of the Blockv SDK is optional, Left out, This will default to the appID attribute.

UserManager

Registering a User

register(payload)

Registration can be done in two ways:

• inline register('first name','last name', 'birthday', 'language', 'password', 'tokens', 'name public', 'avatar public')
• or as an object

Examples

let payload = {
    firstName : 'John',
    lastName : 'Smith',
    birthday : '1970-12-23',
    language : 'en',
    password : '',
    tokens : [
      {
        token : '[phone]',
        token_type : 'phone_number',
        isPrimary : true
      },
      {
        token : '[e-mail]',
        token_type : 'email',
        isPrimary : false
      }
    ],
    namePublic : true,
    avatarPublic : true
}

bv.UserManager.register(payload).then(data =>{
  //do something here
}).catch(err => {
  console.error(err.message);
})

Login with User Credentials

login(payload)

• parameter one is the email address or the mobile number of the user
• parameter two is the type of login (email / phone_number)
• parameter three is the password

• If the password is not set and left blank, an OTP will be sent to the users method of login, ie. email / mobile number.

bv.UserManager.login("[e-mail]", "email", "test").then(data => {
  //proceed with logged in user
}).catch(err => {
  console.error(err.message);
})

loginGuest(guest_id)

• parameter one is the guest id string

bv.UserManager.loginGuest(guest_id).then(data => {
  //proceed with code
}).catch(err => {
  console.error(err.message);
})

Logout the currently logged in user

logout()

Logs out the current user

bv.UserManager.logout().then(data => {
  //proceed to redirect after logout
}).catch(err => {
  console.error(err.message);
})

getAccessToken()

Returns the current Access Token

bv.UserManager.getAccessToken().then(data => {
  // Access Token returned is a String

}).catch(err => {
  console.error(err.message)
})

getCurrentUser()

Returns the current user information

bv.UserManager.getCurrentUser().then(data => {
  //do something with the returned user data
}).catch(err => {
  console.error(err.message);
});

encodeAssetProvider(url)

Checks the current URI that was supplied against the logged in Asset Provider URI and if it is a match, builds a encoded link with the matching params

bv.UserManager.encodeAssetProvider("https://cdndev.blockv.net/blockv/avatars/b9e6581c-bb70-48d1-85eb-6657ee1a3bef.1521806344051057018").then(data => {
  //proceed to use the newly returned url
}).catch(err => {
  console.error(err.message);
});

getCurrentUserTokens()

returns a list of the current user's tokens (emails / phone numbers)

bv.UserManager.getCurrentUserTokens().then(data => {
  //do something here
}).catch(err => {
  console.error(err.message);
});

uploadAvatar(formData)

Example Avatar Upload

function doUpload(){
  let f = document.getElementById('avatar');
  let file = f.files[0];
  let fData = new FormData();
  fData.append('avatar', file);
  bv.UserManager.uploadAvatar(fData);
}

updateUser(payload)

updates the current user with an object containing the new details of the user

Example updating a user

let payload = {
    'first_name' : 'Jane',
    'last_name' : 'Smith',
    tokens : [
      {
        token : '[e-mail]',
        token_type : 'email'
      }
    ]
}

bv.UserManager.updateUser(payload).then(data => {
  //do something here after update
}).catch(err => {
  console.error(err.message);
})

sendTokenVerification(token, token_type)

resends the verification token to the user

bv.UserManager.sendTokenVerification(token, token_type).then(data => {
  //verify the token
}).catch(err => {
  console.error(err.message);
})

getRefreshToken()

returns the current refresh token

bv.UserManager.getRefreshToken().then(data => {
  //do something with the refresh token
}).catch(err => {
  console.error(err.message);
})

verifyUserToken(payload)

verifies the user token that was supplied

let payload = {

    "token": "[e-mail]",
    "token_type": "email",
    "verify_code": "1234"
}
bv.UserManager.verifyUserToken(payload).then(data => {
    // do something after verified
}).catch(err => {
   console.error(err.message);
})

resetPassword(token, token_type){

Sends a login OTP , The OTP may only be used for the .login() API

bv.UserManager.resetPassword("[phone]", "phone_number").then(data => {
     //do something after password is deleted
}).catch(err => {
     console.error(err.message)
})

vAtom Actions

• This is a generic function that takes 3 parameters.
• vatomId is the vatom id
• action is the type of action :: Drop, Pickup , Transfer , Require
• payload is any additional information sent along with the vatom id

bv.Vatoms.performAction(vatomId, action, payload).then(data =>{
  //do something after performing an action with a vAtom
}).catch(err => {
  console.error(err.message);
})

Security Disclosure

If you believe you have identified a security vulnerability with BLOCKv, you should report it as soon as possible via email to [e-mail]. Please do not post it to a public issue tracker.

Author

BLOCKv

License

BLOCKv is available under the BLOCKv AG license. See the LICENSE file for more info.

Changelog

1.1.0

Pull Request [#2] (https://github.com/BLOCKvIO/web-sdk/pull/2)

Added:

Inline docs

Web sockets

Removed:

console.log’s