Getting started

This guide provides you with the basic steps you need to set up your API management environment.

Prerequisites

Before you can begin using the API Mesh, you must install:

• Node.js

• nvm 18.x.x (Mac/Linux) or nvm-windows (Windows)

You will also need:

• An Adobe IO account. If you do not already have an Adobe IO account, install Adobe IO.
• An API key (provided by Adobe)
• An API to integrate (for example, your own API, any public OpenAPI REST endpoint, or an Adobe Experience Manager API)
• (Optional) A working instance of Adobe Commerce with either Luma or Venia sample data. You can also include a Live Search instance. The examples in this guide mainly use Commerce to demonstrate features and functionality.

Install the aio CLI

Install Adobe I/O Extensible CLI by running the following command:

Copy
npm install -g @adobe/aio-cli
Copied to your clipboard
npm install -g @adobe/aio-cli

Configure your environment

Once you have an Adobe IO account, you can use the following command line interface (CLI) command to install the API Mesh plugin in your project directory:

Copy
aio plugins:install @adobe/aio-cli-plugin-api-mesh
Copied to your clipboard
aio plugins:install @adobe/aio-cli-plugin-api-mesh

Next steps

• Proceed to create a mesh.

Last updated 9/11/2023

Was this helpful?

Yes

No