@@ -4,24 +4,24 @@ For all communications with execution server, your application should be registe
44
55Please contact
[email protected] for your credientials.
66
7- ### Get Started
8-
9- Application Params
7+ # Get Started
8+ #### Application Params
109| Key | Description |
1110| --- | --- |
12- | SECRET_KEY | Secret Key is required for encryption. Secret Key should be generated on the Appsfly publisher dashboard. |
13- | APP_KEY | Application key to identify the publisher instance. |
14- | EXECUTOR_URL | Url to reach appsfly.io Microservices. |
11+ | SECRET_KEY | Secret Key is required for encryption. Secret Key should be generated on the Appsfly publisher dashboard |
12+ | APP_KEY | Application key to identify the publisher instance|
13+ | EXECUTOR_URL | Url to reach appsfly.io Microservices |
1514
1615** NOTE:** Above params are needed for checksum generation. Please refer to the methods mention below.
1716
18- Micro Module Params
17+ #### Micro Module Params
18+
1919| Key | Description |
2020| --- | --- |
2121| MODULE_HANDLE | Each micromodule of a service provider is identified by MODULE_HANDLE |
22- | UUID | UniqueID to identify user session. |
22+ | UUID | UniqueID to identify user session|
2323
24- Intent Params
24+ #### Intent Params
2525| Key | Description |
2626| --- | --- |
2727| INTENT | Intent is like an endpoint you are accessing to send message |
@@ -32,11 +32,11 @@ Intent Params
3232### Option 1: SDK
3333The SDK can be included to handle authorization. There is no need for you to handle checksum generation and verification.
3434
35- #### Configuration
35+ ##### Configuration
3636```
3737AppInstance.AFConfig config = new AppInstance.AFConfig("EXECUTOR_URL", "SECRET_KEY", "APP_KEY");
3838```
39- #### Execution
39+ ##### Execution
4040```
4141AppInstance travelProvider = new AppInstance(config, "MODULE_HANDLE");
4242travelProvider.exec("INTENT", JSONObject("PAYLOAD"), "UUID", new Callback() {
@@ -53,28 +53,31 @@ travelProvider.exec("INTENT", JSONObject("PAYLOAD"), "UUID", new Callback() {
5353```
5454
5555### Option 2: API Endpoint
56-
5756appsfly.io exposes a single API endpoint to access Microservices directly.
5857
59- API endpoint : "https://microapps.appsfly.io/executor/exec "
58+ ##### Endpoint
59+ https://microapps.appsfly.io/executor/exec
6060
61- ####
61+ ##### Method
6262POST
6363
64- #### Headers
64+ ##### Headers
6565| Header | Description |
6666| --- | --- |
67- | X-UUID | UUID |
68- | X-App-Key | APP_KEY|
69- | X-Module-Handle | MODULE_HANDLE|
70- | X-Checksum | CHECKSUM. Please go through this gist to generate checksum. |
67+ | X-UUID | [ UUID] ( #UUID ) |
68+ | X-App-Key | [ APP_KEY] ( #APP_KEY ) |
69+ | X-Module-Handle | [ MODULE_HANDLE] ( #MODULE_HANDLE ) |
70+ | X-Checksum | CHECKSUM. Please go through [ this gist] ( ) to generate checksum. |
7171| Content-Type | Must be "application/json" |
7272
73- #### Body
74- ` {
73+ ##### Body
74+ [ INTENT] ( #INTENT ) , [ PAYLOAD] ( #PAYLOAD )
75+ ```
76+ {
7577 "intent":"INTENT",
7678 "data":"PAYLOAD"
77- } `
79+ }
80+ ```
7881
79- #### Response
80- Response format will be dependent on microservice. Please go through this documentation for different microservices.
82+ ##### Response
83+ Response format will be dependent on microservice. Please go through [ this documentation] ( ) for different microservices.
0 commit comments