API Overview

Welcome to the ISAO external API documentation. This API allows you to integrate your applications with ISAO's WhatsApp AI platform to manage contacts, deals, and receive real-time notifications via webhooks.

🚀 Quick Start

1. Get your API Key: Generate an API key from your ISAO dashboard at /dashboard/settings/api-keys
2. Test the connection: Use the test endpoint to verify your API key works
3. Start integrating: Begin with contacts or deals endpoints
4. Set up webhooks: Configure real-time notifications for your integrations

📋 Table of Contents

• Authentication - How to authenticate with API keys
• Contacts API - Manage your contacts programmatically
• Deals API - Create and manage deals through the API
• Webhooks & Zapier - Real-time notifications and Zapier integration
• Error Handling - Error codes and best practices
• Examples - Complete integration examples

🔗 Base URL

Production: https://isao.io/api/external
Staging: https://staging.isao.io/api/external

⚡ Quick Test

Test your API key with a simple request:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://staging.isao.io/api/external/test

Expected response:

{
  "success": true,
  "message": "API key is valid and working",
  "data": {
    "companyId": "your-company-id",
    "permissions": ["contacts:read", "contacts:write"],
    "timestamp": "2024-11-08T09:30:00.000Z"
  }
}

🔧 Supported Integrations

• Zapier: Connect 6000+ apps with REST hooks
• Make (Integromat): Advanced workflow automation
• Custom Applications: Build your own integrations
• Webhooks: Real-time data synchronization

📊 Available Resources

Resource	Description	Permissions Required
Contacts	Manage customer contacts and leads	contacts:read, contacts:write
Deals	Handle sales opportunities and pipeline	deals:read, deals:write
Agents	Access AI agent information	agents:read
Webhooks	Subscribe to real-time events	webhooks:read, webhooks:write

🏷️ API Key Types

Choose the right API key type for your integration:

• Generic: General purpose API access
• Zapier: Optimized for Zapier workflows
• Make: Configured for Make.com scenarios
• Custom: For your own applications

📈 Getting Help

• Support Email: hello@isao.io
• Documentation Issues: GitHub Issues
• Status Page: Check API status and uptime

🔒 Security

• All API requests must be made over HTTPS
• API keys should be kept secure and never exposed in client-side code
• Use environment variables to store API keys
• Rotate API keys regularly for better security

📋 Changelog

• 2024-11-08: Initial API documentation release
• 2024-11-08: Added webhook support for Zapier integration
• 2024-11-08: Enhanced rate limiting and error handling