appsflyio-nodejs-util

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.

Showing:

Popularity

Downloads/wk

1

GitHub Stars

0

Maintenance

Last Commit

4yrs ago

Contributors

2

Package

Dependencies

1

Size (min+gzip)

0.9KB

License

Apache-2.0

Type Definitions

Tree-Shakeable

No?

Categories

Readme

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

KeyDescription
SECRET_KEYSecret Key is required for encryption. Secret Key should be generated on the Appsfly publisher dashboard
APP_KEYApplication key to identify the publisher instance
EXECUTOR_URLUrl to reach appsfly.io Microservices

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

Micro Module Params

KeyDescription
MODULE_HANDLEEach micromodule of a service provider is identified by MODULE_HANDLE
UUIDUniqueID to identify user session

Intent Params

KeyDescription
INTENTIntent is like an endpoint you are accessing to send message
PAYLOADData 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
HeaderDescription
X-UUIDUUID
X-App-KeyAPP_KEY
X-Module-HandleMODULE_HANDLE
X-ChecksumCHECKSUM. Please go through this gist to generate checksum.
Content-TypeMust 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.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial