You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: developers-docs/docs/api/guide.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,14 +3,14 @@ title: API Guide
3
3
sidebar_position: 1
4
4
---
5
5
6
-
Most API access is available for signed requests with private key, which can be downloaded from [dashboard](https://developers.mixin.one/dashboard).
6
+
Most APIs are accessed through requests signed with a private key, which can be downloaded from the[dashboard](https://developers.mixin.one/dashboard).
7
7
8
-
There are three kinds of signature in Mixin:
9
-
1. JWT signature of bot to access private API, [details](#calling-apis)
10
-
2. JWT signature of OAuth user to access private API, [details](#oauth-user-signature)
11
-
3. PIN signature to transfer, withdraw and create withdraw addresses, [details](#pin-signature)
8
+
There are three kinds of signatures in Mixin:
9
+
1. JWT signatures for bots to access private APIs, [details](#calling-apis)
10
+
2. JWT signatures for OAuth users to access private APIs, [details](#oauth-user-signature)
11
+
3. PIN signatures for transfers, withdrawals, and creating withdrawal addresses, [details](#pin-signature)
12
12
13
-
## Choosing An API Server
13
+
## Choosing an API Server
14
14
15
15
For HTTP requests:
16
16
@@ -26,12 +26,12 @@ For WebSocket requests:
26
26
27
27
## Calling APIs
28
28
29
-
Most APIs need to signed with a JSON Web Tokens (JWT) to access. They utilize the secure data transmissions between clients and servers.
29
+
Most APIs must be signed with a JSON Web Token (JWT) before they can be accessed. JWTs provide secure data transmission between clients and servers.
30
30
31
31
### Signing
32
32
33
33
:::tip
34
-
Most Mixin SDK has already provide a JWT generator, and thet can handle the JWT generation and verification automatically. For more information, please refer to [SDK section](/docs/resources/sdk).
34
+
Most Mixin SDKs already provide a JWT generator, and they can handle JWT generation and verification automatically. For more information, please refer to the[SDK section](/docs/resources/sdk).
35
35
:::
36
36
37
37
#### JWT Header
@@ -46,7 +46,7 @@ Most Mixin SDK has already provide a JWT generator, and thet can handle the JWT
46
46
| Parameter | Instruction |
47
47
|:----------|:----------------------|
48
48
| uid | User Id |
49
-
| sid | Session Id|
49
+
| sid | Session ID|
50
50
| iat | issued at |
51
51
| exp | Expiration Time |
52
52
| jti | JWT ID |
@@ -57,7 +57,7 @@ Most Mixin SDK has already provide a JWT generator, and thet can handle the JWT
57
57
```go
58
58
/*
59
59
* uid: User Id
60
-
* sid: Session Id
60
+
* sid: Session ID
61
61
* secret: PrivateKey
62
62
* method: HTTP Request method, e.g.: GET, POST
63
63
* url: URL path without hostname, e.g.: /transfers
Copy file name to clipboardExpand all lines: developers-docs/docs/app/getting-started/read-info.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ GET -H "Authorization: Bearer $ACCESS_TOKEN" https://api.mixin.one/me
32
32
```
33
33
34
34
:::info
35
-
The `user_id` field is an unique id for each "Account" or "User" in the entire Mixin Network.
35
+
The `user_id` field is a unique ID for each "Account" or "User" in the entire Mixin Network.
36
36
37
37
Additionally, if the user is a Mixin Messenger user, you can send messages to them by using [`POST /messages`](/docs/api/messages/send) with the `user_id` field.
38
38
:::
@@ -43,7 +43,7 @@ Additionally, if the user is a Mixin Messenger user, you can send messages to th
43
43
To obtain the asset balance of a user, the `ASSETS:READ` permission is required.
44
44
:::
45
45
46
-
Calling `GET /assets` returns assets with a balance greater than 0. When you calls this API with a token which owned by a new user with zero balance, an empty list will be returned.
46
+
Calling `GET /assets` returns assets with a balance greater than 0. When you call this API with a token owned by a new user with a zero balance, an empty list is returned.
47
47
48
48
```bash
49
49
GET -H "Authorization: Bearer $ACCESS_TOKEN" https://api.mixin.one/assets
@@ -54,7 +54,7 @@ import RespAssets from '@site/docs/_partials/_resp.assets.md'
54
54
<RespAssets />
55
55
56
56
:::info
57
-
The `asset_id` field is an unique id for each asset in the entire Mixin Network.
57
+
The `asset_id` field is a unique ID for each asset in the entire Mixin Network.
58
58
59
59
It can be obtained from [https://mixin.one/snapshots](https://mixin.one/snapshots) by searching for asset code such as `btc`. You can also deposit the asset into the Mixin Messenger wallet and talk to the bot `7000103061`, then search for and copy asset information.
0 commit comments