Skip to content

Commit cb2b130

Browse files
authored
Update README.md
1 parent ad39f86 commit cb2b130

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,32 @@ Java Utils contains resources to help communicate with appsfly.io secure server
33

44
appsfly.io does not whitelist IPs, instead a checkSum should be generated with the Secret Key. To get a Secret Key contact [email protected]
55

6-
## Get Started
6+
### Get Started
77
To start posting messages securely we need the following:
88

9-
| Key | Description |
10-
| --- | --- |
11-
| Module Handle | Unique handle of the micro module. This will be provided by the service provider. |
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. |
149

15-
You will have to generate a checkSum from the parameters, headers with the secret key provided by appsfly.io.
10+
| Value | Key | Description |
11+
| --- | --- | --- |
12+
| Module Handle | MODULE_HANDLE | Unique handle of the micro module. This will be provided by the service provider. |
13+
| Secret Key | SECRET_KEY | Secret Key is required for encryption. Secret Key should be generated on the Appsfly publisher dashboard. |
14+
| App Key | APP_KEY | Application key to identify the publisher instance. |
15+
| Executor Url | EXECUTOR_URL | Url to reach appsfly.io Microservices. |
1616

17-
## Configuration
18-
Configure the app using the following parameters:
1917

20-
* REPO_URL - currently "https://microapps.appsfly.io"
21-
* SECRET_KEY - generated secret key, contact [email protected] for a secret key
22-
* APP_KEY - assigned Application key. Eg: "92ae2562-aebc-468f-009e-aa300d9d39b1"
18+
**NOTE:** You will have to generate a checkSum from the parameters, headers with the secret key provided by appsfly.io.
2319

24-
```
25-
AppInstance.AFConfig config = new AppInstance.AFConfig("REPO_URL", "SECRET_KEY", "APP_KEY");
26-
```
27-
## Package
20+
# Integration options
21+
### Option 1: Package
2822
The SDK can be included to handle the encryption and decryption along with checkSum generation and verification.
2923
You can use it to avoid boiler plate code. If not, you can use the api endpoint.
3024

25+
#### Configuration
26+
```
27+
AppInstance.AFConfig config = new AppInstance.AFConfig("REPO_URL", "SECRET_KEY", "APP_KEY");
28+
```
29+
#### Execution
3130
```
32-
AppInstance travelProvider = new AppInstance(config, "com.domain.ms-travel");
31+
AppInstance travelProvider = new AppInstance(config, "MODULE_HANDLE");
3332
travelProvider.exec("doBooking", new JSONObject() {{
3433
//Set Params Here
3534
// We will take care of checksum
@@ -48,7 +47,7 @@ travelProvider.exec("doBooking", new JSONObject() {{
4847
});
4948
```
5049

51-
## API Endpoint ( "/executor/exec" )
50+
### Option 2: API Endpoint ( "/executor/exec" )
5251

5352
appsfly.io exposes a single API endpoint to access Microservices directly. Headers are used for authentication and sessions will be managed accordingly.
5453

0 commit comments

Comments
 (0)