Partner Integration

Yboard offers partner integration APIs for platforms that want to embed Yboard backend capabilities into their own products.

Overview

Partners can integrate Yboard through two models:

Co-Branded — Yboard branding alongside partner branding
White-Label — Fully branded as the partner’s own backend

Partnership Models

Feature	Co-Branded	White-Label
Branding	Yboard + Partner	Partner only
Pricing	Shared revenue	Custom pricing
Support	Yboard support	Partner support
Customization	Standard	Full

Getting Started

Contact Yboard for partnership details
Receive partner API credentials
Integrate using the Partner API
Configure branding and settings

Partner API

Connect User Account

POST /api/partner/connect
{
  "partner_id": "your-partner-id",
  "user_email": "user@example.com"
}

Sync Project

POST /api/partner/projects/sync
{
  "partner_id": "your-partner-id",
  "project_name": "My Project",
  "region": "us-east-1"
}

Get Project Metadata

GET /api/partner/projects/{project_id}

Manage Projects

# Pause project
POST /api/partner/projects/{project_id}/pause

# Restore project
POST /api/partner/projects/{project_id}/restore

# Delete project
DELETE /api/partner/projects/{project_id}

Usage Tracking

# Get project usage
GET /api/partner/projects/{project_id}/usage

# Get total partnership usage
GET /api/partner/usage

Error Handling

Standard HTTP error codes with JSON error bodies:

{
  "error": "invalid_request",
  "message": "Project not found",
  "status": 404
}

Next Steps

Contact partnerships@yboard.dev for inquiries
Review the full API Reference for detailed endpoint documentation

Overview

Core Features

App Management

Integrations

Partner Integration

Overview

Partnership Models

Getting Started

Partner API

Connect User Account

Sync Project

Get Project Metadata

Manage Projects

Usage Tracking

Error Handling

Next Steps

​Overview

​Partnership Models

​Getting Started

​Partner API

​Connect User Account

​Sync Project

​Get Project Metadata

​Manage Projects

​Usage Tracking

​Error Handling

​Next Steps

Overview

Partnership Models

Getting Started

Partner API

Connect User Account

Sync Project

Get Project Metadata

Manage Projects

Usage Tracking

Error Handling

Next Steps