apideck-migration

Apideck Migration Guide Skill

Overview

This skill helps migrate existing direct third-party API integrations (Salesforce, HubSpot, QuickBooks, Xero, etc.) to Apideck's unified API layer. The benefit is replacing N separate integrations with a single Apideck integration that supports 200+ connectors.

IMPORTANT RULES

• ALWAYS check connector coverage before migrating. Not all operations may be supported through the unified API.
• ALWAYS preserve existing data flows and business logic. Migration should be transparent to end-users.
• USE pass_through for connector-specific fields that don't map to the unified model.
• USE custom field mapping in Vault for recurring connector-specific fields.
• NEVER delete the existing integration code until the Apideck migration is verified in production.
• RECOMMEND a phased migration: start with read operations, then writes, then webhooks.

Migration Strategy

Phase 1: Assessment

1. Inventory existing integrations — List all third-party APIs currently in use
2. Map operations — For each integration, list the CRUD operations and fields used
3. Check coverage — Verify each operation is supported via the Apideck Connector API
4. Identify gaps — Note operations that need pass_through or Proxy API
5. Plan consumer mapping — Decide how your users/tenants map to Apideck consumer IDs

Phase 2: Connection Setup

1. Create Apideck account — Get API key and App ID from the dashboard
2. Enable connectors — Enable the connectors you need in the Apideck dashboard
3. Integrate Vault — Add Vault JS to your frontend for user-managed connections
4. Create consumers — Map your existing users to Apideck consumer IDs
5. Authorize connections — Have users re-authorize via Vault (OAuth is handled automatically)

Phase 3: Read Migration (Low Risk)

Replace read operations first since they're non-destructive:

// BEFORE: Direct Salesforce API
const contacts = await salesforce.sobjects.Contact.find({
  Email: "[email protected]",
});

// AFTER: Apideck Unified API
const { data } = await apideck.crm.contacts.list({
  serviceId: "salesforce",
  filter: { email: "[email protected]" },
});