API Builder — Real-World Examples

Three complete integrations built from scratch, demonstrating different features of the API Builder.

Example 1: Weather API

A common first integration — fetching current weather data.

Gathering information from docs:

• Base URL: https://api.openweathermap.org/data/2.5
• Auth: API Key (passed as a query parameter named appid)
• Endpoint: GET /weather with q (city name) and units parameters

API Builder Configuration

Parameters

Sample Response → Output Fields

{
  "main": { "temp": 72.5, "humidity": 65, "pressure": 1013 },
  "weather": [{ "description": "clear sky", "icon": "01d" }],
  "name": "London"
}

Example 2: CRM Customer Lookup

Fetching a specific customer record by ID — demonstrates path parameters and root accessors.

API Builder Configuration

Parameters

Sample Response → Output Fields

{
  "customer": {
    "id": "CUST-1234",
    "name": "Jane Smith",
    "email": "jane@example.com",
    "company": "Acme Corp",
    "lifetime_value": 12500.00,
    "tags": ["enterprise", "active"]
  }
}

Root Accessor: customer

Example 3: Paginated List API

Fetching a list of recent transactions with pagination — demonstrates query parameters, array response handling, and nested field extraction.

API Builder Configuration

Parameters

Sample Response → Output Fields

{
  "results": [
    {
      "id": "txn_001",
      "amount": 150.00,
      "currency": "USD",
      "customer": { "name": "John Doe", "email": "john@example.com" },
      "status": "completed"
    }
  ],
  "pagination": { "page": 1, "total_pages": 5 }
}

Root Accessor: results

Next Steps

• Troubleshooting & Glossary — Common issues and technical term reference
• Overview — Return to the main API Builder guide