About appsfly.io Dev Kit Node Utils

This library contains resources to help communicate with appsfly.io execution server. For all communications with execution server, your application should be registered and a secret key needs to be generated.

Please contact integrations@appsfly.io for your credientials.

Get Started

Application Params

Key	Description
SECRET_KEY	Secret Key is required for encryption. Secret Key should be generated on the Appsfly publisher dashboard
APP_KEY	Application key to identify the publisher instance
EXECUTOR_URL	Url to reach appsfly.io Microservices

NOTE: Above params are needed for checksum generation. Please refer to the methods mention below.

Micro Module Params

Key	Description
MODULE_HANDLE	Each micromodule of a service provider is identified by MODULE_HANDLE
UUID	UniqueID to identify user session

Intent Params

Key	Description
INTENT	Intent is like an endpoint you are accessing to send message
PAYLOAD	Data payload

Integration options

Option 1: SDK

The SDK can be included to handle authorization. There is no need for you to handle checksum generation and verification.

Install

npm i appsflyio-nodejs-util --save

OR

npm install appsflyio-nodejs-util --save

Configuration

var appsflyioUtil = require("appsflyio-nodejs-util");
var app = new appsflyioUtil.AppInstance({executorUrl:"EXECUTOR_URL", secret:"SECRET_KEY", appKey:"APP_KEY"});

Execution

app.exec("MODULE_HANDLE", "INTENT", JSON.parse(PAYLOAD), UUID).then(function(result){
 //Handle Result
}).else(function(error){
 //Handle Error
});

Option 2: API Endpoint

appsfly.io exposes a single API endpoint to access Microservices directly.

Endpoint

EXECUTOR_URL/executor/exec

Method

POST

Headers

Header	Description
X-UUID	UUID
X-App-Key	APP_KEY
X-Module-Handle	MODULE_HANDLE
X-Checksum	CHECKSUM. Please go through this gist to generate checksum.
Content-Type	Must be "application/json"

Body

INTENT, PAYLOAD

{
  "intent":"INTENT",
  "data":"PAYLOAD"
 } 

Response

Response format will be dependent on microservice. Please go through this documentation for different microservices.