Do you want to create a Mesh implementation for your blockchain? Or integrate with an existing Mesh implementation? Getting started with the Mesh API depends on your goals.

In general, once you implement Mesh API with a blockchain, you can integrate applications that use the Mesh API to interact with that blockchain (or any blockchain that has a Mesh implementation).

​
Implementing Mesh for your Blockchain

To make a blockchain more accessible with Mesh API:

  1. Refer to the API Reference. We have Mesh specifications to help you check what the APIs request response should be.

  2. Implement the endpoints. The mesh-specifications repository contains all the API endpoints that you need to implement and test your code. If you are coding in Golang, see our Go SDK.

  3. Deploy the Mesh implementation with the blockchain node. Write a functional Docker file to do this. Follow this guide on Docker deployment for more information. The references in the mesh-ecosystem repo that you can use to see how developers implement the Mesh API for their assets.

  4. Test your implementation with the mesh-cli tool. Once you run the blockchain node, you can use the mesh-cli tool to test your implementation. The tool runs a basic check against the Mesh API specs and will make sure your implementation functions correctly.

​
Integrating Applications with Mesh API

Once you have a Mesh implementation, you can use the Mesh client to integrate applications with your blockchain. You can also integrate using existing Mesh implementations. Here’s the best way to get started with this task:

  1. Refer to the API Reference. We have Mesh specifications to help you check what the APIs request response should be.

  2. Choose a Mesh blockchain implementation to work with. You can find a collection of community-driven implementations mesh-ecosystem repository in GitHub.

  3. Deploy the Mesh implementation with the blockchain node. Write a functional Docker file to do this. Follow this guide on Docker deployment for more information. The references in the mesh-ecosystem repo can also guide you.

  4. Test requests and responses using the Mesh API endpoints. You can find the entire specification in our Full Reference documentation. For a quick overview, read the next section.

​
Mesh Quick Reference Guide

This guide provides an overview of the Mesh API endpoints. For more information on these endpoints, read the API Reference documentation.

​
Next Steps

If you have any questions, you can check out our Discord to find the answer or submit your own questions. Happy coding!