Skip to main content

Create a Unified API

1

Open Catalog

Go to Catalog
2

Create

Click Create Unified API

Basic Details

The name sets the API path: /unified/{name}

Add Resources

Resources are the data types in your API (e.g., orders, inventory).
1

Open Resources Tab

Click Resources tab
2

Add Resource

Click Add Resource
3

Name Resource

Enter name in snake_case (e.g., orders)

Define Schema

The schema describes your response structure:

Add Methods

Methods define operations on resources.
1

Select Resource

Select your resource
2

Open Mapping Tab

Click Mapping tab
3

Add Method

Click Add Method
Standard methods: list, get, create, update, delete

Configure Mappings

For each integration, define how to translate data.

Query Mapping

Transform query parameters:

Response Mapping

Transform responses using JSONata:

Request Body Mapping

For create/update operations:

Static Responses

For endpoints that return fixed data:
  1. Enable Static Mapping
  2. Define the response:
No API call is made - the static response is returned directly.

Before and After Steps

Before Steps

Run before the main API call:
  • Fetch related data
  • Validate inputs
  • Set up context

After Steps

Run after the main API call:
  • Enrich responses
  • Fetch complete records after creates
  • Log events