Skip to content

Commit 1e48d92

Browse files
author
Karthik Thirumalasetti
authored
Update README.md
1 parent 7691bf1 commit 1e48d92

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Please contact [email protected] for your credientials.
3535
### Option 1: SDK
3636
The SDK can be included to handle authorization. There is no need for you to handle checksum generation and verification.
3737

38-
##### Install
38+
#### Setup SDK
3939

4040
Maven
4141
###### Step 1. Add repo to your root pom.xml
@@ -48,7 +48,7 @@ Maven
4848
</repositories>
4949
```
5050

51-
Step 2. Add the dependency
51+
###### Step 2. Add the dependency
5252
```
5353
<dependencies>
5454
<dependency>
@@ -70,19 +70,19 @@ allprojects {
7070
}
7171
```
7272

73-
Step 2. Add the dependency
73+
###### Step 2. Add the dependency
7474
```
7575
dependencies {
7676
compile 'com.github.User:Repo:Tag'
7777
}
7878
7979
```
8080

81-
##### Configuration
81+
#### Configuration
8282
```
8383
AppInstance.AFConfig config = new AppInstance.AFConfig("EXECUTOR_URL", "SECRET_KEY", "APP_KEY");
8484
```
85-
##### Execution
85+
#### Execution
8686
```
8787
AppInstance travelProvider = new AppInstance(config, "MODULE_HANDLE");
8888
travelProvider.exec("INTENT", JSONObject("PAYLOAD"), "UUID", new Callback() {
@@ -101,13 +101,13 @@ travelProvider.exec("INTENT", JSONObject("PAYLOAD"), "UUID", new Callback() {
101101
### Option 2: API Endpoint
102102
appsfly.io exposes a single API endpoint to access Microservices directly.
103103

104-
##### Endpoint
104+
#### Endpoint
105105
https://microapps.appsfly.io/executor/exec
106106

107-
##### Method
107+
#### Method
108108
POST
109109

110-
##### Headers
110+
#### Headers
111111
| Header | Description |
112112
| --- | --- |
113113
| X-UUID | [UUID](#UUID) |
@@ -116,7 +116,7 @@ POST
116116
| X-Checksum | CHECKSUM. Please go through [this gist](https://gist.github.com/prateektc/95e649649ee819b300914de76330369b) to generate checksum. |
117117
| Content-Type | Must be "application/json" |
118118

119-
##### Body
119+
#### Body
120120
[INTENT](#INTENT), [PAYLOAD](#PAYLOAD)
121121
```
122122
{
@@ -125,5 +125,7 @@ POST
125125
}
126126
```
127127

128-
##### Response
128+
----------------------------------------
129+
130+
### Micro Service Response
129131
Response format will be dependent on microservice. Please go through [this documentation](https://github.com/appsflyio/devkit-javautils/blob/master/MICROSERVICE_SPEC.md) for different microservices.

0 commit comments

Comments
 (0)