Add TON Center API v2 auth details page #1494
Conversation
This comment has been minimized.
This comment has been minimized.
|
/review |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
/review |
laviniat1996
added
the
3p
|
|
||
| ## Overview | ||
|
|
||
| The API v2 requires an API key for all methods, including the JSON-RPC endpoint. |
There was a problem hiding this comment.
The requirement of the API key should be specified accurately. An API key is required if the developer desires to make more than one request per second. There is no method that is fully limited by the API Key, just for RPS>1 user will get the HTTP Error 429:
|
|
||
| **Definitions:** | ||
|
|
||
| - `<HOST>` - The base URL of the TON Center API instance (`toncenter.com` for example). |
There was a problem hiding this comment.
Instead of a "for example" structure, let's accurately specify public hosts. It may be a 2-row table HOST for the Testnet and HOST the Mainnet environments.
| The API v2 requires an API key for all methods, including the JSON-RPC endpoint. | ||
| The key can be sent either in an HTTP header or as a query parameter. | ||
|
|
||
| To obtain an API key, see the [TON Center API key guide](/ecosystem/api/toncenter/get-api-key). |
There was a problem hiding this comment.
Do we have any expiration limit on the API key? Are there any recommendations to rotate the API key?
| The key can be sent either in an HTTP header or as a query parameter. | ||
|
|
||
| To obtain an API key, see the [TON Center API key guide](/ecosystem/api/toncenter/get-api-key). | ||
|
|
There was a problem hiding this comment.
Add a danger reminder of the importance of securely storing the API key.
Example:
Security
Prefer read‑only tokens for public access, scope server
tokens to only what you need, rotate long‑lived
tokens, and store them in a secrets manager.
Never expose admin tokens in client‑side code.
Extra reference: https://docs.stripe.com/keys-best-practices
| "method": "getMasterchainInfo", | ||
| "params": {} | ||
| }' | ||
| ``` |
There was a problem hiding this comment.
Can we specify the error codes related to API-KEYs here?
reveloper
added
the
scope: api
closes #1025
Adds a page that explains how devs can use the API keys for v2 API