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.
| 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.
| Key | Description |
|---|---|
| MODULE_HANDLE | Each micromodule of a service provider is identified by MODULE_HANDLE |
| UUID | UniqueID to identify user session |
| Key | Description |
|---|---|
| INTENT | Intent is like an endpoint you are accessing to send messages |
| DATA | Data payload |
The DLL can be included to handle authorization. There is no need for you to handle checksum generation and verification.
Add References
Step 1. Add integration dll to your project references
// Integration DLL can be downloaded from this repo
AppInstance.AFConfig config = new AppInstance.AFConfig("EXECUTOR_URL", "SECRET_KEY", "APP_KEY");
AppInstance provider = new AppInstance(config, "MODULE_HANDLE");
provider.exec("INTENT", "INTENT_DATA_OBJECT", "UUID", (error, result) => { Console.WriteLine(result) });
OR
var response = provider.execSync("INTENT", "INTENT_DATA_OBJECT", "UUID");
appsfly.io exposes a single API endpoint to access Microservices directly.
EXECUTOR_URL/executor/exec
POST
| Header | Description |
|---|---|
| X-UUID | UUID |
| X-App-Key | APP_KEY |
| X-Module-Handle | MODULE_HANDLE |
| X-Encrypted | BOOLEAN |
| Content-Type | Must be "text/plain" |
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhZl9jbGFpbSI6IntcImludGVudFwiOlwiSU5URU5UXCIsXCJkYXRhXCI6XCJQQVlMT0FEXCJ9In0.ZPUfElCCO2FiSQwtur6t80kHFTOzsvnJGQ-j_70WZ0k
Body must have the encrypted checksum for the following JSON. Please use JOSE-JWT to generate and verify checksum. INTENT, PAYLOAD
{
"intent":"INTENT",
"data":"PAYLOAD"
}
Covert the above JSON to string and append it to key "af_claim" as follows:
{"af_claim": "{\"intent\":\"INTENT\", \"data\":\"PAYLOAD\"}"}
The response of the microservices is encrypted and you will be needing JWT decode or verify with the secret key to decode the response. After decode, the response is in "af_claim" key. Please go through this documentation for different microservices.