Guides

🚀 Quickstart guide

Suggest Edits

Overview

Quick start.
After learning this chapter, you can gain:

  • Quick connection to the world of Web3
    You can access all supported public blockchains by creating an API key, without additional configurations.
  • Application isolation
    You can create multiple API keys to isolate applications and secure production.
  • Dual support for HTTPS and WSS
    Connections can be established over HTTPS and WebSocket Secure (WSS). This can meet the different requirements of applications.

For Web3 application developers, the cost of building nodes on public blockchains is relatively high, and the stability and security of the node running cannot be ensured. In this issue, a node service is available in public preview for free (allows you to create a maximum of ten API keys). To interact with blockchains through HTTPS/WSS, developers only need to get the API key that is required to establish connections to RPC nodes.
Before you use the node service to connect to blockchains, sign up for an account on the ZAN platform. Then, you can use this account to log in to the ZAN console and create the API keys required for Web3 application development.

🔏 Preparing a ZAN account

If you have not signed up for a ZAN account

  1. Click sign up in the upper right corner of the ZAN Node Service Console.
  2. Create your ZAN account and login.
    After entering your email address and password, you need to click Continue to receive an email that will help you activate your account.

If you have registered

Click Log In in the upper right corner of the ZAN Node Service Console. Enter your account and password, then you can start for a free plan!

Start for Free

After completing the registration and login for a ZAN account, you can start for a free plan! The page will automatically redirect you to the product console to create an API Key required for connecting to node services.

Step1: Creating your first API key

You can create multiple API keys on the ZAN platform to isolate applications and secure production environments. Each API key you create allows you to access all supported public blockchains without additional configurations. The steps to create an API key are as follows:

  1. Click Start for Free on the ZAN Node Service Console.
  2. If you have not created an API key, the following message appears, guiding you to create your first API key.
  3. Click Create Now, and specify an API key name.
    Naming your API key can help you manage its application scenarios and purposes.
  4. Click Yes to create the API key.
    Once the API key is created, you can view some basic information about the API key in the list, such as its name, creator, and creation time.

    On the left side of the page, you can view the available Cerdits of the current plan. On the right side of the page, you can view your current plan.

    📘

    Note:

    The Free Plan provides a free quota of 300 million credits by default. The system calculates the number of consumed credits based on the consumption of each RPC node. The number of consumed credits also varies based on the API methods that are called. For more information, see Credit pricing details.

Step2: Getting API key information

After an API key is created, you can view the API key and the network URLs for the blockchains supported by the platform.

View path

Click the target API key panel to enter the API key management page. On the Get Started tab, you can view the API key and the network URLs for each blockchain.

📘

Note:

You can click Copy to button next to the API key or network URL to copy all the information.

Connectable blockchains

You can connect RPC nodes to blockchains that the platform currently supports by using the API key you get. The platform will support more EVM-compatible blockchains and other blockchains in the future.

To help you directly get the network URLs of different blockchains, the platform automatically generates URLs concatenated with the API key for you, and provides HTTPS and WSS connection methods.

❗️

Attention:

If you're using the free version, you must upgrade to the paid version to use WebSockets in Solana.

To switch networks such as the testnet and mainnet, click the drop-down menu in the upper-right corner of the specific blockchain module. Different URLs are provided for different networks. You can click Copy to the right side of the URL to copy it.

Stpe3: Verify if the API Key is Usable

You can verify the validity of your obtained API key by testing a specific API interface. For example, you can test it using the get_blockNumber interface on the Ethereum mainnet.

  1. On the API key management page, check all the blockchain information currently supported by the API key.

  2. Copy the current API key.

    If you are invoking the API interface through your own code, copy the complete URL address under the Ethereum blockchain's mainnet.
    This URL address is composed of the node service IP routing, ecological information, network information, and the user API key, which is run by zan.
    For example: https://api.zan.top/node/v1/eth/mainnet/57ea531a7b6442eca58d85a6fc7d\*\*\*\*。

  3. Enter the API reference documentation and find the get_blockNumber interface on the Ethereum mainnet.

  4. Find Path Params on the page, and paste the API key you just copied into the parameter value.
    The platform provides a free public parameter value for verifying the API interface, but this value is only suitable for low Credit consumption interface calls. For high consumption interface calls, you need to use the API key.

  5. Click Try it on the right side of the page, and you will see the successful return value of the call in the RESPONSE window below.

Start for Price Plan

For Growth or Pro

  1. Click Price Plan on the product introduction page, then click Buy Now.
  2. See Purchase plan to purchase plan.

For Enterprise

  1. Click Price Plan on the product introduction page, then click Contract Us.

  2. The page will automatically scroll to the bottom of the product page. Please fill in your custom requirements in the text box, read and check the agreement below, and then click Send a message.

  3. After a successful application, the page will display the following message.


    You can click View Detail in the pop-up window to check the status of your application on the homepage.

    📘

    Note:

    After we receive your application, we will provide feedback as soon as possible and notify you by email. Please check your email regularly.

📚 What to do next

Updated 14 days ago