Skip to content

Latest commit

 

History

History

out-of-band

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
OutOfBand.js
OutOfBand.js
 
 
README.md
README.md
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 

README.md

Sample App using Out-of-Band invitations to identify a returning jser

This is a sample app which is using Out-of-Band invitations to identify a returning user. The application is using Verity REST API. For more information on Out-of-band invitations read this document

Requirements:

  • You have received Verity application endpoint, Domain DID and REST API key from Evernym
  • You have NodeJs v12 installed
  • You have ngrok installed (https://ngrok.com/)

NOTE: The application webhook endpoint (/webhook) needs to be served on a public URL so that Verity Application server can send messages to it. Ngrok is used here as a developer tool to provide a publicly available endpoint that tunnels to the local listening port of the App. If you have capabilities to start the application on a cloud infrastructure then you don't need to install and start ngrok - you just need to specify your URL address in the webhookUrl parameter (e.g. http://<your_cloud_ip>:4000/webhook)

To try out this app follow these steps:

  • In a separate terminal window start ngrok for port 4000 and leave it running :
ngrok http 4000
  • Install required NodeJs packages:
npm install
  • Change the values for verityUrl, domainDid, xApiKey, and webhookUrl with your values in the OutOfBand.js file:
const verityUrl = '<< PUT VERITY APPLICATION SERVER URL HERE >>' // address of Verity Application Server
const domainDid = '<< PUT DOMAIN DID HERE >>' // your Domain DID on the multi-tenant Verity Application Server
const xApiKey = '<< PUT X-API-KEY HERE >>' // REST API key associated with your Domain DID
const webhookUrl = '<< PUT WEBHOOK URL HERE >>' // public URL for the webhook endpoint

Sample values might look like this:

const verityUrl = 'https://vas.pps.evernym.com'
const domainDid = 'W1TWvjCTGzHGEgbzdh5U4b'
const xApiKey = 'AkdrCwUhNXiQi3zgwKw2KhR6muAX1Q18phP4cfuMtvq4:4cBQC9EsbMa9T96KA4noZwLJQuVcd6KBwaqFhRqZQKFWT45VEm3jbPCm8S6bqhwh3UKEKAPkHeLz9Gb1d1YE1dWv'
const webhookUrl = 'https://1326d835655f.ngrok.io/webhook'
  • Start OutOfBand app
node OutOfBand.js

Observe messages being exchanged between the app and the Verity application server on the console output. Scan QR codes with a ConnectMe device when required.