Skip to content

Update API ref docs #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
goldenpostny wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update API ref docs #79

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 4 additions & 14 deletions docs/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,15 +290,9 @@ type ActiveContract = {
### 2. Connect Flow

1. Validates or clears cached session
2. Requests a ticket (`POST /api/v1/.connect/ticket`)
3. Opens wallet using:
```
/api/v1/.connect/?ticketId=xxxx
```
4. Opens websocket:
```
ws://.../.connect/pair/ws/:ticketId
```
2. Requests a ticket (`POST /api/v1/.connect/pair/tickets`)
3. Opens websocket (`wss://<host>/api/v1/.connect/pair/ws/:ticketId`)
4. Opens wallet UI (`/.connect/?ticketId=xxxx`)

### 3. Approval / Rejection

Expand All @@ -307,11 +301,7 @@ type ActiveContract = {

### 4. Session Validation

Before reconnecting, SDK verifies session via:

```
GET /api/v1/profile
```
Before reconnecting, SDK verifies session via `GET /api/v1/.connect/pair/account`.

If invalid, -> session cache is cleared automatically.

Expand Down