MIracal Logo
iracalBusiness
Get startedDownload app
Developer Platform & APIs

Build on Miracal Business App

Connect your tools, automate workflows, and extend the platform for your business or your clients.

Request API AccessExplore Building Blocks
REST & Webhook ArchitectureHMAC Cryptographic SigningIsolated Sandbox Environments
Miracal Business App Developers
Platform Architecture

Overview

The Miracal Developer Platform lets you integrate Miracal Business App's messaging, catalog, and order data with your own systems — whether that's a CRM, an inventory tool, a custom dashboard, or an automation workflow.

Direct Two-Way Sync: Keep inventory, chats, and checkout statuses mirrored continuously.
Event-Driven Webhooks: React instantaneously to customer messages and cart state transitions.
Scoped Least-Privilege Keys: Ensure your custom apps only access the specific resources they need.
Integration Topologies
Internal CRM / ERP Systems
HubSpot, Salesforce, SAP, Custom SQL
< 50ms sync
Order & Fulfillment Automation
Auto-ship labels, invoice generation, receipts
Real-time
Webhooks & Event Bus
New lead alerts, order payment callbacks
Instant push
Real-World Use Cases

What you can build

Unleash custom capabilities by wiring Miracal into your existing operational infrastructure.

Customer Relationship

CRM & helpdesk integrations

Sync Miracal conversations and order data into tools your team already uses like HubSpot, Salesforce, or Zendesk.

Fulfillment

Automated order workflows

Trigger actions in your own systems (inventory updates, invoicing, shipping labels) when an order status changes.

E-Commerce

Custom catalog sync

Push product and inventory updates from your existing e-commerce or POS system into a Miracal catalog automatically.

Business Intelligence

Analytics & reporting dashboards

Pull conversation and order data into your own BI tools like Tableau, PowerBI, or BigQuery for deep operational insights.

AI & Automations

Chatbot / auto-response extensions

Build logic beyond built-in quick replies and automations, for complex multi-step FAQ handling or custom lead qualification.

API Surfaces

Core Building Blocks

Modular programmatic interfaces for messaging, webhook triggers, digital catalogs, and order lifecycles.

Messaging API

REST

Send and receive messages, media, and templates programmatically.

POST /v1/messages, GET /v1/messages/{id}

Webhooks

Real-time

Get real-time notifications for new messages, order status changes, and catalog updates.

POST /v1/webhooks/subscribe, HMAC-SHA256

Catalog API

Commerce

Create, update, and sync product listings and collections.

GET /v1/catalog, POST /v1/catalog/items

Orders API

Lifecycle

Read and update order status (Pending → Confirmed → Shipped → Delivered → Cancelled).

GET /v1/orders, PATCH /v1/orders/{id}/status

Business Profile API

Config

Manage business hours, greeting/away messages, and quick-reply templates.

GET /v1/profile, PUT /v1/profile/hours
Sample Request: Dispatch Notification
curl -X POST https://api.miracal.app/v1/messages \
  -H "Authorization: Bearer mb_live_9a8f27..." \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+919876543210",
    "type": "template",
    "template": {
      "name": "order_confirmed",
      "parameters": {
        "order_id": "ORD-84920",
        "total": "₹2,499"
      }
    }
  }'
Onboarding Roadmap

Getting Started

Five guided milestones from first credential issue to full production deployment.

01

Request API access

Apply through the Developer Console. Access is provisioned per verified business organization to ensure trust and compliance.

02

Get your API credentials

Generate your cryptographically signed secret token scoped strictly to your business account permissions.

03

Read the docs

Explore full endpoint references, request schemas, authentication signatures, and account concurrency limits.

04

Test in sandbox

A dedicated sandbox environment lets you test outbound message sends, webhook payloads, and order status transitions without affecting live customer data.

05

Go live

Once testing passes validation, promote your integration endpoints to production credentials with zero downtime.

Authentication & Security

Signed, Business-Scoped Tokens
All API requests require a cryptographically signed, business-scoped bearer token (e.g. Bearer mb_live_...).
HMAC Signed Webhooks
Webhooks include an X-Miracal-Signature header computed via HMAC SHA-256 so you can verify payloads genuinely originated from Miracal.
Principle of Least Privilege
Access strictly respects zero-trust authorization — a token only reaches the data and actions your business has explicitly approved.

Rate Limits & Usage Policies

Tier-Based Concurrency
API throughput is provisioned per account tier with burst buffering and transparent HTTP 429 Retry-After headers to prevent congestion.
Zero Spam Tolerance
Messaging and automation built on the API must follow the same Acceptable Use and Messaging Policy that applies to in-app usage.
Respect Opt-Outs & Consent
No unsolicited bulk messaging, cold promotional blasts, or circumventing explicit customer stop requests.

Developer Community

Join other developers building on Miracal Business App to share integration patterns, ask architectural questions, and get early access to new API capabilities.

Support for Developers

Direct access to API solutions engineers, dedicated integration debugging, and platform feature requests.