Skip to content

Commit 10eaeb5

Browse files
banoolbanool
authored
Direct users to dedicated API Gateway docs site (#347)
1 parent e5c35f0 commit 10eaeb5

File tree

5 files changed

+28
-90
lines changed

5 files changed

+28
-90
lines changed

‎apps/docusaurus/docs/apis/aptos-labs-developer-portal.md

+3-32
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,11 @@
11
---
2-
title: "Aptos Labs Developer Portal"
2+
title: "Aptos Labs API Gateway"
33
---
44

55
import BetaNotice from '../../src/components/\_dev_portal_beta_notice.mdx';
66

77
<BetaNotice />
88

9-
The [Aptos Labs Developer Portal](https://developers.aptoslabs.com) is your gateway to access Aptos Labs provided APIs in a quick and easy fashion to power your dapp.
10-
It consists of a Portal (UI) and a set of API Gateways operated by Aptos Labs.
9+
[API Gateway](https://developers.aptoslabs.com) is your gateway to access Aptos Labs provided APIs in a quick and easy fashion to power your dapp. It consists of a Portal (UI) and a set of API Gateways operated by Aptos Labs.
1110

12-
The Developer Portal aims to make it easier to build dapps by:
13-
14-
1. Providing [unified domain names/URLs](../nodes/networks.md) for each API.
15-
2. Giving you personalized examples on how to use each API.
16-
3. Observability into your personal usage, error rates and latency of APIs.
17-
4. Rate limiting by API developer account/app instead of origin IP.
18-
5. (Coming Soon) Customizable Rate limits for high traffic apps.
19-
20-
In order to create an Aptos Labs developer account simply go to https://developers.aptoslabs.com/ and follow the instructions.
21-
22-
### Default Rate Limits for Developer Portal accounts
23-
24-
Currently, the following rate limits apply:
25-
26-
1. GRPC Transaction Stream: 20 concurrent streams per user
27-
2. Fullnode API: 5000 requests per 5 minutes sliding window.
28-
3. GraphQL API: 5000 requests per 5 minutes sliding window.
29-
30-
Note that requests for the Fullnode API / GraphQL API are counted separately, so you can make 5000 Fullnode API requests AND 5000 GraphQL API requests in the same 5 minutes window. The rate limit is applied as a continuous sliding window.
31-
32-
Rate limits are customizable per user upon request. If you have a use-case that requires higher rate limits than the default, please open a support case through one of the supported channels in the portal.
33-
34-
### Known Limitations
35-
36-
1. Only authenticated access is supported.
37-
38-
At the moment the new URLs introduced by the Developer Portal / API Gateway only support requests with an API Key (Bearer authentication).
39-
Effectively this means you can only use the new API gateway provided URLs from backend apps that can securely hold credentials.
40-
We plan to add soon support for anonymous authentication in combination with more sophisticated rate limit protections, which then makes new URLs usable in client-side only applications like Browser Wallets etc.
11+
Learn more about API Gateway at the dedicated [API Gateway docs site](https://developers.aptoslabs.com/docs).

‎apps/docusaurus/docs/nodes/networks.md

+16-18
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,19 @@ hide_table_of_contents: true
55

66
# Aptos Networks
77

8-
| Description | Mainnet | Testnet | Devnet |
9-
| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
10-
| **REST API** | https://api.mainnet.aptoslabs.com/v1 | https://api.testnet.aptoslabs.com/v1 | https://api.devnet.aptoslabs.com/v1 |
11-
| **REST API Spec** | <a href="https://api.mainnet.aptoslabs.com/v1/spec#/">Link</a> | <a href="https://api.testnet.aptoslabs.com/v1/spec#/">Link</a> | <a href="https://api.devnet.aptoslabs.com/v1/spec#/">Link</a> |
12-
| **Indexer GraphQL API** | https://api.mainnet.aptoslabs.com/v1/graphql | https://api.testnet.aptoslabs.com/v1/graphql | https://api.devnet.aptoslabs.com/v1/graphql |
13-
| **Indexer GraphQL API Spec** | <a href="https://cloud.hasura.io/public/graphiql?endpoint=https://api.mainnet.aptoslabs.com/v1/graphql">Link</a> | <a href="https://cloud.hasura.io/public/graphiql?endpoint=https://api.testnet.aptoslabs.com/v1/graphql">Link</a> | <a href="https://cloud.hasura.io/public/graphiql?endpoint=https://api.devnet.aptoslabs.com/v1/graphql">Link</a> |
14-
| **[Dev Portal] Fullnode API** | https://api.mainnet.aptoslabs.com/v1 | https://api.testnet.aptoslabs.com/v1 | https://api.devnet.aptoslabs.com/v1 |
15-
| **[Dev Portal] Indexer GraphQL API** | https://api.mainnet.aptoslabs.com/v1/graphql | https://api.testnet.aptoslabs.com/v1/graphql | https://api.devnet.aptoslabs.com/v1/graphql |
16-
| **[Dev Portal] GRPC Transaction Stream** | https://grpc.mainnet.aptoslabs.com | https://grpc.testnet.aptoslabs.com | https://grpc.devnet.aptoslabs.com |
17-
| **Faucet** | No Faucet | https://faucet.testnet.aptoslabs.com/ | https://faucet.devnet.aptoslabs.com/ |
18-
| **Genesis and Waypoint** | https://github.com/aptos-labs/aptos-networks/tree/main/mainnet | https://github.com/aptos-labs/aptos-networks/tree/main/testnet | https://github.com/aptos-labs/aptos-networks/tree/main/devnet |
19-
| **Chain ID** | 1 | 2 | [On Aptos Explorer **select Devnet from top right**](https://explorer.aptoslabs.com/?network=Devnet). |
20-
| **Epoch duration** | 7200 seconds | 7200 seconds | 7200 seconds |
21-
| **Network providers** | Fully decentralized. | Managed by Aptos Labs on behalf of Aptos Foundation. | Managed by Aptos Labs on behalf of Aptos Foundation. |
22-
| **Release cadence** | Monthly | Monthly | Weekly |
23-
| **Wipe cadence** | Never. | Never. | On update. |
24-
| **Purpose** | The main Aptos network. | Long-lived test network. | Bleeding edge and exploratory. |
25-
| **Network status** | Always live. | Always live. | Almost always live, with brief interruptions during updates. |
8+
| Description | Mainnet | Testnet | Devnet |
9+
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
10+
| **Node REST API** | https://api.mainnet.aptoslabs.com/v1 | https://api.testnet.aptoslabs.com/v1 | https://api.devnet.aptoslabs.com/v1 |
11+
| **Node REST API Spec** | <a href="https://api.mainnet.aptoslabs.com/v1/spec#/">Link</a> | <a href="https://api.testnet.aptoslabs.com/v1/spec#/">Link</a> | <a href="https://api.devnet.aptoslabs.com/v1/spec#/">Link</a> |
12+
| **Indexer GraphQL API** | https://api.mainnet.aptoslabs.com/v1/graphql | https://api.testnet.aptoslabs.com/v1/graphql | https://api.devnet.aptoslabs.com/v1/graphql |
13+
| **Indexer GraphQL API Spec** | <a href="https://cloud.hasura.io/public/graphiql?endpoint=https://api.mainnet.aptoslabs.com/v1/graphql">Link</a> | <a href="https://cloud.hasura.io/public/graphiql?endpoint=https://api.testnet.aptoslabs.com/v1/graphql">Link</a> | <a href="https://cloud.hasura.io/public/graphiql?endpoint=https://api.devnet.aptoslabs.com/v1/graphql">Link</a> |
14+
| **GRPC Transaction Stream** | https://grpc.mainnet.aptoslabs.com | https://grpc.testnet.aptoslabs.com | https://grpc.devnet.aptoslabs.com |
15+
| **Faucet** | No Faucet | https://faucet.testnet.aptoslabs.com/ | https://faucet.devnet.aptoslabs.com/ |
16+
| **Genesis and Waypoint** | https://github.com/aptos-labs/aptos-networks/tree/main/mainnet | https://github.com/aptos-labs/aptos-networks/tree/main/testnet | https://github.com/aptos-labs/aptos-networks/tree/main/devnet |
17+
| **Chain ID** | 1 | 2 | [On Aptos Explorer **select Devnet from top right**](https://explorer.aptoslabs.com/?network=Devnet). |
18+
| **Epoch duration** | 7200 seconds | 7200 seconds | 7200 seconds |
19+
| **Network providers** | Fully decentralized. | Managed by Aptos Labs on behalf of Aptos Foundation. | Managed by Aptos Labs on behalf of Aptos Foundation. |
20+
| **Release cadence** | Monthly | Monthly | Weekly |
21+
| **Wipe cadence** | Never. | Never. | On update. |
22+
| **Purpose** | The main Aptos network. | Long-lived test network. | Bleeding edge and exploratory. |
23+
| **Network status** | Always live. | Always live. | Almost always live, with brief interruptions during updates. |

‎apps/docusaurus/src/components/_dev_portal_beta_notice.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:::info Beta
22

3-
Developer Portal is currently in beta. Please report any problems you encounter by creating an issue in the [aptos-core](https://github.com/aptos-labs/aptos-core/issues/new?assignees=@geekflyer,@dport,@blakezimmerman&labels=api-gateway&projects=&template=dev_portal_issue.md&title=%5BDev+Portal%5D+) repo.
3+
API Gateway is currently in beta. Please report any problems you encounter by creating an issue in the [aptos-core](https://github.com/aptos-labs/aptos-core/issues/new?assignees=@geekflyer,@dport,@blakezimmerman&labels=api-gateway&projects=&template=dev_portal_issue.md&title=%5BDev+Portal%5D+) repo.
44

55
:::

‎apps/nextra/pages/en/build/apis/aptos-labs-developer-portal.mdx

+5-34
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,16 @@
11
---
2-
title: "Aptos Labs Developer Portal"
2+
title: "Aptos Labs API Gateway"
33
---
44

55
import { Callout } from "nextra/components";
66

7-
# Aptos Labs Developer Portal
7+
# Aptos Labs API Gateway
88

99
<Callout type="info">
10-
Developer Portal is currently in beta. Please report any problems you encounter
10+
API Gateway is currently in beta. Please report any problems you encounter
1111
by creating an [issue in the aptos-core](https://github.com/aptos-labs/aptos-core/issues/new?assignees=@geekflyer,@dport,@blakezimmerman&labels=api-gateway&projects=&template=dev_portal_issue.md&title=%5BDev+Portal%5D) repo.
1212
</Callout>
1313

14-
The [Aptos Labs Developer Portal](https://developers.aptoslabs.com) is your gateway to access Aptos Labs provided APIs in a quick and easy fashion to power your dapp.
15-
It consists of a Portal (UI) and a set of API Gateways operated by Aptos Labs.
14+
[API Gateway](https://developers.aptoslabs.com) is your gateway to access Aptos Labs provided APIs in a quick and easy fashion to power your dapp. It consists of a Portal (UI) and a set of API Gateways operated by Aptos Labs.
1615

17-
The Developer Portal aims to make it easier to build dapps by:
18-
19-
1. Providing [unified domain names/URLs](../../network/nodes/networks.mdx) for each API.
20-
2. Giving you personalized examples on how to use each API.
21-
3. Observability into your personal usage, error rates and latency of APIs.
22-
4. Rate limiting by API developer account/app instead of origin IP.
23-
5. (Coming Soon) Customizable Rate limits for high traffic apps.
24-
25-
In order to create an Aptos Labs developer account simply go to https://developers.aptoslabs.com/ and follow the instructions.
26-
27-
### Default Rate Limits for Developer Portal accounts
28-
29-
Currently, the following rate limits apply:
30-
31-
1. GRPC Transaction Stream: 20 concurrent streams per user
32-
2. Fullnode API: 5000 requests per 5 minutes sliding window.
33-
3. GraphQL API: 5000 requests per 5 minutes sliding window.
34-
35-
Note that requests for the Fullnode API / GraphQL API are counted separately, so you can make 5000 Fullnode API requests AND 5000 GraphQL API requests in the same 5 minutes window. The rate limit is applied as a continuous sliding window.
36-
37-
Rate limits are customizable per user upon request. If you have a use-case that requires higher rate limits than the default, please open a support case through one of the supported channels in the portal.
38-
39-
### Known Limitations
40-
41-
1. Only authenticated access is supported.
42-
43-
At the moment the new URLs introduced by the Developer Portal / API Gateway only support requests with an API Key (Bearer authentication).
44-
Effectively this means you can only use the new API gateway provided URLs from backend apps that can securely hold credentials.
45-
We plan to add soon support for anonymous authentication in combination with more sophisticated rate limit protections, which then makes new URLs usable in client-side only applications like Browser Wallets etc.
16+
Learn more about API Gateway at the dedicated [API Gateway docs site](https://developers.aptoslabs.com/docs).

0 commit comments

Comments
 (0)