Tutorials
We provide a number of tutorials that guide you through the process of designing and building custom integrations.
- Basic integration - How to integrate system that exposes content through a basic REST API.
- Headless CMS integration - How to integrate a headless CMS.
- Commerce integration - How to integrate a commerce system.
Basic integration
This custom integration is a simplified example that demonstrates the essential features and concepts involved when building a custom integration. The scenario involves allowing a Uniform Canvas editor to add information about one or more monsters to a landing page.
info
This example uses a publically available REST API that provides access to details about the fantasy role-playing game Dungeons & Dragons. This API was selected because it offers a lot of varied content that is easy to understand. In addition, the API itself can run on your local environment.
Use cases
This tutorial will guide you through the process of building an integration that supports the following use cases:
Uniform administrator can add a custom integration to a project.
Uniform administrator can configure a connection to a specific API endpoint that provides information about monsters, and test that the endpoint is active.
Canvas designer can add a parameter to a component that enables a Canvas editor to select a monster. The Canvas designer can also configure a filter that limit the monsters that are available for the editor to select from.
Canvas editor can set the value on a component parameter by selecting select a monster from a list retrieved from the API endpoint.
Front-end developer can create components that display details about the monster selected by the Canvas editor.
Implementations
We provide tutorials for your preferred front-end technology.
- Next.js
- Nuxt [coming soon]
Headless CMS integration
Since creating custom integrations for headless CMSes is one of the most common type of custom integration people build for Uniform, we provide an example that focuses on this specific type of system.
info
Coming soon.
Commerce integration
Since creating custom integrations for headless commerce systems is one of the most common type of custom integration people build for Uniform, we provide an example that focuses on this specific type of system.
info
Coming soon.