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 |
| PAYLOAD | Data payload |
The DLL can be included to handle authorization. There is no need for you to handle checksum generation and verification.
Add References
// Util DLL can be downloaded from this repo
AppInstance.AFConfig config = new AppInstance.AFConfig("EXECUTOR_URL", "SECRET_KEY", "APP_KEY");
AppInstance activitiesProvider = new AppInstance(config, "MODULE_HANDLE");
activitiesProvider.exec("INTENT", "PAYLOAD_TXT", "UUID", (result) => { Console.WriteLine(result) });
OR
activitiesProvider.execSync("INTENT", "PAYLOAD_TXT", "UUID", (result) => { Console.WriteLine(result) });
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-Checksum | CHECKSUM. Please use Appsfly DLL to generate and verify checksum. |
| Content-Type | Must be "application/json" |
{
"intent":"INTENT",
"data":"PAYLOAD"
}
Response format will be dependent on microservice. Please go through this documentation for different microservices.