Introduction

In order to understand better how Sherry Links work we have the following sequence diagram. We see in the diagram the API object. In this an endpoint that returns the metadata must be exposed and for this you can use the tool-framework that suits you best. We have defined examples with NextJS , Express JS and Cloudflare Workers to facilitate the understanding and implementation.

Each of the objects in the diagram above corresponds to:

As you can see in the diagram, the Developer uses the SDK to define the metadata, then publishes an API that exposes an endpoint (Guides), this endpoint will return the metadata in the correct format so that finally the Client makes a request to that endpoint to render the mini-app.

To better understand how this works, let’s use the following example:

Suppose you’ve published an API exposing the following endpoint to return the metadata:

Once your endpoint is ready, you need to publish your mini-app on Sherry. After it passes the validation process, here’s what happens internally:

For instance, if your mini-app’s endpoint is the one above, you could visualize it on Sherry at the following URL:

Here’s the breakdown:

Final Result

Internally, the process works as follows: