Partner API References

Partner API Documentation #

Comprehensive API reference for Flowmatix partners to build integrations, manage customer accounts, and access platform functionality.

Partner Authentication #

Partners use special API keys with extended permissions:

Authorization: Bearer PARTNER_API_KEY
X-Partner-ID: YOUR_PARTNER_ID
Content-Type: application/json

Customer Management APIs #

Create Customer Account #

POST /api/v1/partners/customers

{
  "company_name": "Acme Corporation",
  "contact_email": "admin@acme.com",
  "contact_name": "John Smith",
  "phone": "+1234567890",
  "plan": "professional",
  "billing_cycle": "monthly"
}

Get Customer Details #

GET /api/v1/partners/customers/{customer_id}

Retrieve comprehensive customer account information including usage statistics and billing details.

Update Customer Account #

PUT /api/v1/partners/customers/{customer_id}

Update customer account settings, plan, and billing information.

List Partner Customers #

GET /api/v1/partners/customers

Parameters:

• limit – Number of customers to return
• offset – Pagination offset
• status – Filter by account status
• plan – Filter by subscription plan

Billing and Commission APIs #

Get Commission Report #

GET /api/v1/partners/commissions

Parameters:

• start_date – Report start date (YYYY-MM-DD)
• end_date – Report end date (YYYY-MM-DD)
• customer_id – Filter by specific customer

Get Invoice Details #

GET /api/v1/partners/invoices/{invoice_id}

Retrieve detailed invoice information including line items and commission calculations.

Usage Analytics APIs #

Customer Usage Statistics #

GET /api/v1/partners/customers/{customer_id}/usage

Get detailed usage metrics for a specific customer:

• Message volume by channel
• Workflow execution counts
• API request statistics
• Storage utilization

Partner Performance Metrics #

GET /api/v1/partners/metrics

Comprehensive partner performance dashboard data:

• Total customers and revenue
• Growth metrics and trends
• Customer satisfaction scores
• Support ticket statistics

White-Label APIs #

Custom Branding #

POST /api/v1/partners/customers/{customer_id}/branding

{
  "logo_url": "https://partner.com/logo.png",
  "primary_color": "#007bff",
  "secondary_color": "#6c757d",
  "custom_domain": "app.partner.com"
}

Custom Email Templates #

PUT /api/v1/partners/customers/{customer_id}/email-templates

Customize system email templates with partner branding and messaging.

Provisioning APIs #

Create Sandbox Environment #

POST /api/v1/partners/sandbox

Create isolated sandbox environments for testing and demos.

Deploy Customer Configuration #

POST /api/v1/partners/customers/{customer_id}/deploy

Deploy pre-configured workflows, templates, and settings to customer accounts.

Support and Ticketing APIs #

Create Support Ticket #

POST /api/v1/partners/support/tickets

{
  "customer_id": "customer_123",
  "subject": "Integration Issue",
  "description": "Customer experiencing webhook failures",
  "priority": "high",
  "category": "technical"
}

Get Ticket Status #

GET /api/v1/partners/support/tickets/{ticket_id}

Track support ticket progress and resolution status.

Webhook Events for Partners #

Partners can subscribe to special webhook events:

• customer.created – New customer account created
• customer.upgraded – Customer plan upgrade
• customer.cancelled – Customer subscription cancelled
• commission.earned – New commission earned
• invoice.generated – New invoice created

Rate Limits #

Partner API rate limits:

• Standard Partners: 5,000 requests per hour
• Premium Partners: 10,000 requests per hour
• Enterprise Partners: 25,000 requests per hour

SDKs and Libraries #

Official SDKs available for:

• Node.js / JavaScript
• Python
• PHP
• C# / .NET
• Java