Skip to content

Commit c99ed91

Browse files
committed
updated readme
1 parent 25f03b9 commit c99ed91

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

sample-server/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
## Endpoints
44

5-
- GET `/start`: Call Incode's `/omni/start` API to create an Incode session which will include a token in the JSON response. This token can be shared with Incode SDK client apps to do token based initialization, which is a best practice.
5+
- GET `/start`: Call Incode's `/omni/start` API to create an Incode session which will include a `token` in the JSON response. This token can be shared with Incode SDK client apps to do token based initialization, which is a best practice.
66

77
It also performs basic storage of sessions in the `sessions` directory to help implement `renderRedirectToMobile`in frontend.
88

9-
At session generation it will generate an `uuid` and save the session in `session/<UUID>.json`, later if you call `/start` again passing a valid `uuid` it will retrieve the stored session instead of creating a new one.
9+
At session generation it will generate an `uniqueId` and save the session in `session/<uniqueId>.json`, later if you call `/start` again passing a valid `uniqueId` it will retrieve the stored session instead of creating a new one.
1010

1111
- GET `/onboarding-url`: Calls incodes `/omni/start` and then with the token calls `/0/omni/onboarding-url` to retrieve the unique onboarding-url for the newly created session.
1212

@@ -94,7 +94,7 @@ Open the `Forwarding` adress in a web browser. The URL should look similar to th
9494

9595
Now you should be able to visit the following routes to receive the associated payloads:
9696
1. `https://yourforwardingurl.app/start`
97-
2. `https://yourforwardingurl.app/start?uuid=0e810732-6e7e-4512-aaa5-1ae2e1f8df46`
97+
2. `https://yourforwardingurl.app/start?uniqueId=0e810732-6e7e-4512-aaa5-1ae2e1f8df46`
9898
3. `https://yourforwardingurl.app/onboarding-url`
9999
4. `https://yourforwardingurl.app/onboarding-url?redirectionUrl=https%3A%2F%2Fexample.com%2F`
100100

0 commit comments

Comments
 (0)