Connections Overview

A connection in API Mapper represents a configured link to an external REST API. Each connection contains all the information needed to fetch and process data from that API.

Connection Components

Every connection consists of:

1. Basic Settings

• Name: A descriptive name for your connection
• Base URL: The API's root URL (e.g., https://api.example.com)
• Description: Optional notes about the connection

2. Endpoint Configuration

• Path: The specific endpoint (e.g., /products)
• Method: HTTP method (GET, POST, etc.)
• Query Parameters: Optional URL parameters
• Headers: Custom HTTP headers

3. Authentication

• None: For public APIs
• API Key: Key in header or query parameter
• Bearer Token: OAuth2/JWT authentication
• Basic Auth: Username and password

Learn more about authentication →

4. Field Mapping

Define which fields from the API response should be available in YOOtheme:

• Field Name: How the field appears in YOOtheme
• JSON Path: Location in the API response
• Type: Text, Number, Image, etc.

Learn more about field mapping →

5. Caching

• Cache Duration: How long to cache responses
• Cache Key: Unique identifier for cached data

Connection Limits

The number of connections depends on your license:

Managing Connections

Creating a Connection

See Your First Connection for a step-by-step guide.

Editing a Connection

1. Go to API Mapper settings
2. Click on the connection name
3. Make your changes
4. Click Save

Duplicating a Connection

Use the Duplicate action to create a copy of an existing connection. Useful when setting up similar API endpoints.

Deleting a Connection

1. Click the Delete button
2. Confirm the deletion

Next Steps

• Authentication Methods
• Field Mapping
• Caching Options