APIs & Protocols

Integrate with external services and APIs using REST, GraphQL, SOAP, and OpenAPI protocols with authentication, validation, and auto-completion.

Quick Navigation

Available Nodes

Authentication Support

Supported Authentication Methods

Authentication Configuration Example

{
  "authentication": {
    "type": "bearer",
    "token": "{{ctx.consts.API_TOKEN}}"
  },
  "headers": {
    "X-API-Version": "2023-11-01",
    "X-Client": "axellero-workflow"
  }
}

Use Cases & Patterns

Third-Party Integrations

CRM Systems, Payment Processors, Social Media APIs

{
  "method": "POST",
  "endpoint": "/api/v1/customers",
  "body": {
    "name": "{{ctx.nodes.customerForm.outputs.name}}",
    "email": "{{ctx.nodes.customerForm.outputs.email}}",
    "source": "axellero-integration"
  }
}

Data Synchronization

Database Updates, Cache Invalidation, Search Index Updates

{
  "operation": "syncCustomerData",
  "parameters": {
    "customerId": "{{ctx.vars.customerId}}",
    "lastModified": "{{ctx.nodes.timer.outputs.currentTime}}",
    "workspace": "{{ctx.workspace_slug}}"
  }
}

Workflow Orchestration

Service Coordination, Multi-step Processes, Event Chains

{
  "operationId": "processOrder",
  "parameters": {
    "orderId": "{{ctx.nodes.orderCreator.outputs.orderId}}",
    "paymentToken": "{{ctx.nodes.paymentProcessor.outputs.token}}",
    "shippingAddress": "{{ctx.vars.shippingAddress}}"
  }
}

Workflow Context Integration

Dynamic Request Building

Use workflow data in API requests:

{
  "endpoint": "/users/{{ctx.user.id}}/preferences",
  "body": {
    "preferences": "{{ctx.nodes.preferenceForm.outputs.preferences}}",
    "workspace": "{{ctx.workspace_slug}}",
    "timestamp": "{{ctx.nodes.timer.outputs.currentTime}}"
  }
}

Conditional Operations

Execute different operations based on workflow state:

{
  "operation": "{{ctx.vars.action === 'create' ? 'createResource' : 'updateResource'}}",
  "parameters": {
    "resourceId": "{{ctx.vars.action === 'update' ? ctx.vars.existingId : null}}",
    "data": "{{ctx.nodes.dataValidator.outputs.validatedData}}"
  }
}

User-Scoped Requests

Include user context and permissions:

{
  "headers": {
    "X-User-ID": "{{ctx.user.id}}",
    "X-User-Role": "{{ctx.user.roles[0]}}",
    "X-Workspace": "{{ctx.workspace_id}}"
  },
  "parameters": {
    "includePrivateData": "{{ctx.user.roles.includes('admin')}}"
  }
}

Editor Features

Schema-Aware Editing

API protocol nodes provide editing features:

• Auto-completion: Endpoints, parameters, and schema-based suggestions
• Validation: Syntax and schema validation
• Documentation: Inline API documentation and examples
• Testing: Built-in request testing and response preview

Protocol-Specific Features

For complete editor details, see Code Editing & Schema Reference.

Response Processing

Standardized Response Format

All API protocol nodes return consistent response structures:

{
  "statusCode": 200,
  "headers": {
    "content-type": "application/json",
    "x-rate-limit-remaining": "99"
  },
  "data": {
    // API response data
  },
  "success": true,
  "metadata": {
    "requestTime": 245,
    "retryCount": 0,
    "protocol": "REST"
  }
}

Error Handling

Common error response patterns:

{
  "statusCode": 400,
  "error": "Invalid request data",
  "data": {
    "code": "VALIDATION_ERROR",
    "details": ["Missing required field: name"]
  },
  "success": false
}

Configuration & Best Practices

Configurable Features:

• Retry Logic: Set retry attempts and delay for failed requests
• Timeout Settings: Configure request timeout values
• Error Handling: Define custom error response processing

Implementation Guidelines

1. Use Workflow Context: Leverage dynamic data from workflow variables and nodes
2. Implement Error Handling: Plan for API failures and edge cases
3. Validate Responses: Implement response validation for data integrity
4. Set Appropriate Timeouts: Configure timeout values based on API characteristics

Protocol Selection Guide

When to Use REST API

✅ Good for:

• Modern web services and microservices
• Simple CRUD operations
• Public APIs with standard HTTP methods
• Services without formal specifications

❌ Avoid for:

• Complex data relationships requiring multiple requests
• Services with strict type validation requirements

When to Use GraphQL

✅ Good for:

• Efficient data fetching with complex relationships
• APIs with strong schema definitions
• Reducing over-fetching and under-fetching

❌ Avoid for:

• Simple single-resource operations
• File uploads and binary data
• Caching-heavy scenarios

When to Use SOAP

✅ Good for:

• Enterprise systems and legacy integrations
• Services requiring WS-Security compliance
• Formal contracts with WSDL definitions
• Mission-critical applications with strict standards

❌ Avoid for:

• Modern web applications
• Mobile app backends
• High-performance scenarios requiring minimal overhead

When to Use OpenAPI

✅ Good for:

• API-first development workflows
• Services with comprehensive OpenAPI specifications
• Automatic code generation requirements
• Teams using specification-driven development

❌ Avoid for:

• APIs without OpenAPI specifications
• Rapidly changing API contracts
• Internal services with informal contracts

Getting Started

Quick Start Steps

1. Choose Protocol: Select the appropriate API protocol node
2. Configure Endpoint: Set up the API endpoint URL and basic settings
3. Set Authentication: Configure secure authentication credentials
4. Define Operation: Specify the API operation and parameters
5. Test Integration: Validate the integration with sample data
6. Handle Responses: Implement response processing and error handling

Common Issues & Solutions

Connection Timeouts:

• Increase timeout values for slow APIs
• Implement retry logic with exponential backoff

Authentication Failures:

• Verify credential configuration and token validity
• Check authentication method compatibility

Rate Limiting:

• Implement request throttling
• Use built-in rate limit detection and backoff

Schema Validation Errors:

• Verify request format against API documentation
• Use schema validation tools for debugging

Choose the appropriate API protocol node for your integration requirements to connect workflows with external services.