Native Integration Flows

As a Vercel integration provider, when you create a native product integration, you need to set up the integration server and use the Vercel marketplace Rest API to manage the interaction between the integration user and your product.

The following diagrams help you understand how information flows in both directions between the integration user, Vercel and your native integration product for each key interaction between the integration user and the Vercel dashboard.

When a Vercel user, who wants to install a provider native integration, selects the Storage tab of the Vercel dashboard, followed by Create Database, they are taken through the following steps to provide the key information required for the provider to be able to create a product for this user.

After reviewing the flow diagram below, explore the sequence for each step:

• Select storage product
• Select billing plan
• Submit store creation

Understanding the details of each step will help you set up the installation section of the integration server.

When the integration user selects a storage provider product, an account is created for this user on the provider's side if the account does not exist. If that's the case, the user is presented with the Accept Terms modal.

Using the installation id for this product and integration user, the Vercel dashboard presents available billing plans for the product. The integration user then selects a plan from the list which is updated on every user input change.

After confirming the plan selection, the integration user is presented with information fields that the integration provider specified in the metadata schema section of the integration settings. The user updates these fields and submits the form to initiate the creation of the store for this user on the provider platform.

When an integration user selects the Manage button for a product integration from the Vercel dashboard's Integrations tab, they are taken to the installation settings page for that integration. When they select the Open in [provider] button, they are taken to the provider's dashboard page in a new window. The diagram below describes the flow of information for authentication and information exchange when this happens.

This flow happens when a provider edits information about a resource in the provider's system.

This flow happens when a user who has installed the product integration edits information about it on the Vercel dashboard.

This flow happens when a provider rotates the credentials of a resource in the provider system.