Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelthomas2774 committed May 25, 2023
1 parent 2e1cdc9 commit 7910715
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,23 @@ interface ZncaApiRequest {
* A random (v4) UUID.
*/
request_id?: string;
/**
* The user's Nintendo Account ID.
*
* For Coral authentication (hash method 1) this will be set automatically from the `token` if not provided.
* (Although providing it is recommended.)
* For web service authentication (hash method 2) this must be provided. If it is not provided an empty string
* will be used, which will cause the resulting f token to be rejected if/when Nintendo starts validating this.
*/
na_id?: string;
/**
* The user's Coral user ID.
*
* Only used for web service authentication (hash method 2).
*
* This will be set automatically from the `token` if not provided. (Providing it is recommended.)
*/
coral_user_id?: string;
}
```

Expand Down

0 comments on commit 7910715

Please sign in to comment.