Developer Guide

Developer API Keys Setup & Usage Guide

ChumiAI provides Developer API Keys to allow you to integrate ChumiAI features directly into your own applications, websites, or e-commerce platforms.

Explore API DocsGet Started
Setting up API Keys
Authentication
Supported Features
API Reference

1. Setting up API Keys

To generate an API key:

  1. 1Log in to the ChumiAI Client Portal.
  2. 2Navigate to Settings > Developer Settings > API Keys.
  3. 3Click Create New Key.
  4. 4Give your key a descriptive name (e.g., "Shopify Sync" or "Mobile App Messaging").
  5. 5Select the required Scopes (Permissions).
  6. 6Click Generate.

Critical Security Notice

Copy and save your API key immediately after generation. For security reasons, it will only be shown once and cannot be retrieved later.

2. Authentication

All requests to the ChumiAI API using an API key must include the key in the X-API-Key HTTP header.

Example Request
curl -X GET "https://api.chumiai.app/api/v1/whatsapp/templates" 
     -H "X-API-Key: chumi_abc123..." 
     -H "Content-Type: application/json"

3. Supported Features

API Keys can currently be used for the following developer-focused features:

Messaging & Conversations

Automate your customer communication

  • Send Messages: Send WhatsApp messages to your customers.
  • Retrieve Conversations: Fetch conversation history for a specific customer.
  • Webhooks: Receive real-time updates when messages are received (requires webhook setup).

Product Catalog Syncing

Keep your ChumiAI catalog in sync with your external store

  • Create/Update Products: Push products from Shopify, WooCommerce, or custom sites.
  • Manage Inventory: Update product availability and details.

Contact Management

Sync your CRM with ChumiAI

  • Create Contacts: Add new customers to ChumiAI automatically.
  • Update Contact Info: Keep customer details consistent across platforms.

4. Best Practices

Never expose your API key in client-side code

HTML/JavaScript on the client side can be inspected. Always use API keys in server-side environments only.

Use restricted scopes

Minimize risk if a key is compromised by only granting the permissions you need.

Rotate your keys regularly

Periodically generate new keys and revoke old ones as part of your security policy.

Revoke unused keys

Remove any API keys that are no longer in use from the dashboard immediately.

5. API Reference Summary

ResourceBase PathKey Use Case
WhatsApp/api/v1/whatsappSending messages & templates
Conversations/api/v1/conversationsManaging chat history
Products/api/v1/productsSyncing e-commerce catalogs
Contacts/api/v1/contactsSyncing customer data