ECOSIRE Developer Portal

Build powerful integrations with our comprehensive REST API. 818+ endpoints, full OpenAPI spec, and TypeScript SDK.

View API Documentation Get API Key

818+

API Endpoints

Modules

REST

Architecture

Locales Supported

API

Quick Start

Get up and running with the ECOSIRE API in minutes

Authenticate

Use OAuth2 via Authentik or API keys to obtain a JWT bearer token for API access.

POST /api/auth/login

Make Your First Call

Use the bearer token in the Authorization header to call any API endpoint.

# List all contacts

curl -H "Authorization: Bearer $TOKEN" \

https://api.ecosire.com/api/contacts

Use the SDK

Install our TypeScript SDK for type-safe API calls with built-in error handling.

import { EcosireClient } from "@ecosire/sdk";

const client = new EcosireClient({ apiKey });

const contacts = await client.contacts.list();

57 Modules

API Modules

Explore 57 modules covering every aspect of enterprise operations

Core

AuthUsersContactsProductsOrdersProjectsSettings

Finance

AccountingSalesPurchaseBillingInvoicing

Operations

InventoryManufacturingPOSRentalPlanning

Human Resources

EmployeesRecruitmentTime OffAttendanceExpensesPayrollAppraisals

Marketing & Growth

Email MarketingEventsMarketing AutomationAnalyticsAffiliatesLoyalty

AI & Automation

ECOSIRE AISelf-Evolving EngineContent GenerationSEO Scanner

Security

Authentication

Two authentication methods to fit your integration needs

HttpOnly Cookies

Secure cookie-based authentication for browser applications. Tokens are never exposed to JavaScript.

Automatic with the web application
HttpOnly, Secure, SameSite=Lax
7-day refresh token rotation

Bearer Token

Use JWT bearer tokens for server-to-server integrations and API clients.

// Authorization header

Authorization: Bearer <your_jwt_token>

// Or via HttpOnly cookie

Cookie: ecosire_auth=<token>

Interactive

API Playground

Try any endpoint directly from your browser. Select an endpoint, fill in parameters, and send live requests to the ECOSIRE API.

ECOSIRE API Playground

api.ecosire.com/api

POST/auth/login

Authorization

Request Body (JSON)

https://api.ecosire.com/api/auth/login

Code Snippet

curl -X POST \ \
  "https://api.ecosire.com/api/auth/login" \ \
  -H "Content-Type: application/json" \
  -d '{   "email": "[email protected]",   "password": "secret" }'

SDK

SDK Code Examples

Install the ECOSIRE SDK in your language of choice and explore 6 common operations with full code snippets.

Installation

Choose your language and install the ECOSIRE SDK

npm install @ecosire/sdk

Code Examples

6 common operations with full SDK snippets

1. Authentication

Obtain a JWT token and include it in subsequent requests.

import { EcosireClient } from '@ecosire/sdk';

const client = new EcosireClient({
  baseUrl: 'https://api.ecosire.com/api',
  apiKey: process.env.ECOSIRE_API_KEY,
});

// Login with credentials
const session = await client.auth.login({
  email: '[email protected]',
  password: 'secret',
});

console.log(session.token);   // JWT token
console.log(session.user);    // { id, email, name, role }

// All subsequent calls auto-attach the token
const contacts = await client.contacts.list();

Webhooks

Webhook Events

ECOSIRE sends real-time webhook events to your server when key actions occur — payments, subscriptions, license activations, and more.

Webhook Event Tester

Explore all 8 webhook events, generate cURL commands, and verify HMAC signatures.

Select Webhook Event

Your Webhook URL (optional)

Checkout Completed

checkout.session.completed

Fired when a customer completes payment in a Stripe Checkout Session.

Trigger: Customer pays for a product in the storefront. Auto-grants licenses and creates order.

Example JSON payload delivered to your webhook endpoint for checkout.session.completed.

json

{
  "id": "evt_1ABCxyz",
  "object": "event",
  "type": "checkout.session.completed",
  "created": 1711000000,
  "data": {
    "object": {
      "id": "cs_live_abc123",
      "object": "checkout.session",
      "customer_email": "[email protected]",
      "amount_total": 24900,
      "currency": "usd",
      "mode": "payment",
      "payment_status": "paid",
      "metadata": {
        "userId": "usr_01HXYZ",
        "productIds": "[\"prd_01HODOOCRM\"]"
      }
    }
  }
}

All Webhook Events

Event	Trigger	Fields
`checkout.session.completed` Checkout Completed	Customer pays for a product in the storefront. Auto-grants licenses and creates order.	7 fields
`invoice.paid` Invoice Paid	Monthly/annual subscription renewal is processed. Reactivates suspended licenses and logs billing record.	6 fields
`customer.subscription.deleted` Subscription Cancelled	Subscription period ends and cancel_at_period_end was true, or immediate cancellation was requested. Suspends all associated licenses.	5 fields
`customer.subscription.updated` Subscription Updated	Customer changes their plan, payment fails and subscription pauses, or subscription resumes after payment. Syncs license status accordingly.	5 fields
`charge.refunded` Charge Refunded	Admin or customer initiates a refund via Stripe Dashboard or API. Revokes associated licenses and marks the order as refunded.	5 fields
`payment_intent.payment_failed` Payment Failed	Subscription renewal fails or one-time payment is declined. Marks order as payment_failed and sends failure notification email.	5 fields
`license.validated` License Validated	Odoo module calls POST /licenses/validate on server startup. Used for audit logging and anomaly detection.	5 fields
`license.activated` License Activated	First time POST /licenses/activate is called for a domain. Logs the activation for audit and security monitoring.	5 fields

Verify webhook signatures in production

Always verify the stripe-signature header for Stripe events using your STRIPE_WEBHOOK_SECRET. For license events, verify the X-License-Signature header using ECOSIRE_LICENSE_SECRET. Unverified events should be rejected with 401.

Reference

Error Codes

All API errors follow RFC 7807 (Problem Details for HTTP APIs). Every error includes a machine-readable code and human-readable message.

Status	Meaning	When it occurs
200	OK	Successful GET or POST returning data
201	Created	Successful resource creation (POST)
204	No Content	Successful DELETE or PUT with no body
400	Bad Request	Invalid request body, missing required fields, or malformed JSON
401	Unauthorized	Missing, expired, or invalid JWT token
403	Forbidden	Valid token but insufficient role (e.g. requires admin)
404	Not Found	Resource does not exist or has been deleted
409	Conflict	Duplicate resource — email already registered, license already active
422	Unprocessable	Validation failed — Zod schema rejection with field-level details
429	Too Many Requests	Rate limit exceeded — see Retry-After header
500	Server Error	Unexpected server error — stack trace hidden in production

Error Response Shape

{
  "statusCode": 422,
  "error": "Unprocessable Entity",
  "message": "Validation failed",
  "details": [
    { "field": "email", "message": "Invalid email address" },
    { "field": "password", "message": "Must be at least 8 characters" }
  ]
}

Rate Limits

Fair usage limits to ensure API stability for all users

Endpoint	Rate Limit
POST /support	5/min
POST /crm/capture	10/min
POST /ecosire-ai/ask	20/min
POST /licenses/validate	30/min
POST /licenses/activate	10/min
POST /newsletter/subscribe	5/min
Authenticated endpoints	100/min

Rate Limit Response Headers

X-RateLimit-LimitMaximum requests allowed in the window

X-RateLimit-RemainingRequests remaining in the current window

X-RateLimit-ResetUnix timestamp when the window resets

Retry-AfterSeconds to wait before retrying (on 429)

SDK

Resources & SDK

Everything you need to build your integration

Interactive API Docs

Explore and test every endpoint with our Swagger UI interface. Try API calls directly from your browser.

Open Docs

OpenAPI Spec

Download the full OpenAPI 3.0 specification in JSON format. Import into Postman, Insomnia, or your own tools.

Download JSON

TypeScript SDK

Type-safe API client with auto-completion, error handling, and built-in retry logic.

npm install @ecosire/sdk

API Keys

API Key Management

Create and manage API keys from your dashboard. Each key can be scoped to specific permissions and rotated independently.

Create API Keys

Generate new API keys from Dashboard → Settings → API Keys. Each key has a name, optional expiry date, and role scope.

Scoped Permissions

Keys can be scoped to read-only, read-write, or admin. Admin keys can manage other keys and access all endpoints.

Key Rotation

Rotate keys at any time without downtime. The old key remains valid for 24 hours after rotation for a smooth transition.

Usage Analytics

View per-key request counts, error rates, and last-used timestamps from the API Keys dashboard page.

Environment Keys

Maintain separate keys for development, staging, and production. Production keys log all requests for audit purposes.

Webhook Secrets

Webhook endpoints also use a separate ECOSIRE_LICENSE_SECRET for HMAC-SHA256 signature verification on license events.

Using an API Key

# Pass the key as a Bearer token in the Authorization header
curl https://api.ecosire.com/api/contacts \
  -H "Authorization: Bearer ecos_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

# Or use HttpOnly cookies (browser-based auth — set automatically on login)
# Cookie: ecosire_auth=<jwt_token>

FAQ

Frequently Asked Questions

Common questions about the ECOSIRE API

How do I get API access?

Sign up for an ECOSIRE account and navigate to Dashboard > API Keys to generate your API credentials. API access is available on all plans.

Is there a free tier?

Yes, all ECOSIRE accounts include API access. Rate limits vary by plan. The free tier supports up to 1,000 API calls per day.

What authentication methods are supported?

We support OAuth2 via Authentik (recommended for web apps), JWT bearer tokens (for server-to-server), and API keys (for simple integrations).

Do you have webhook support?

Yes, ECOSIRE supports webhooks for real-time event notifications. Configure webhook endpoints in Dashboard > Settings > Webhooks.

What is the API uptime SLA?

We maintain 99.9% uptime for all API endpoints. Status page and incident history are available at status.ecosire.com.

Ready to Build?

Get your API key and start building integrations in minutes.

Get API Key View Documentation

import { EcosireClient } from '@ecosire/sdk'; const client = new EcosireClient({ baseUrl: 'https://api.ecosire.com/api', apiKey: process.env.ECOSIRE_API_KEY, }); // Login with credentials const session = await client.auth.login({ email: '[email protected]', password: 'secret', }); console.log(session.token); // JWT token console.log(session.user); // { id, email, name, role } // All subsequent calls auto-attach the token const contacts = await client.contacts.list();

{ "id": "evt_1ABCxyz", "object": "event", "type": "checkout.session.completed", "created": 1711000000, "data": { "object": { "id": "cs_live_abc123", "object": "checkout.session", "customer_email": "[email protected]", "amount_total": 24900, "currency": "usd", "mode": "payment", "payment_status": "paid", "metadata": { "userId": "usr_01HXYZ", "productIds": "[\"prd_01HODOOCRM\"]" } } } }

Event

checkout.session.completed

Checkout Completed

invoice.paid

Invoice Paid

customer.subscription.deleted

Subscription Cancelled

customer.subscription.updated

Subscription Updated

charge.refunded

Charge Refunded

payment_intent.payment_failed

Payment Failed

license.validated

License Validated

license.activated

License Activated

Status

Meaning

200

201

Created

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

422

Unprocessable

429

Too Many Requests

500

Server Error

{ "statusCode": 422, "error": "Unprocessable Entity", "message": "Validation failed", "details": [ { "field": "email", "message": "Invalid email address" }, { "field": "password", "message": "Must be at least 8 characters" } ] }

Endpoint

Rate Limit

POST /support

5/min

POST /crm/capture

10/min

POST /ecosire-ai/ask

20/min

POST /licenses/validate

30/min

POST /licenses/activate

10/min

POST /newsletter/subscribe

5/min

Authenticated endpoints

100/min

# Pass the key as a Bearer token in the Authorization header curl https://api.ecosire.com/api/contacts \ -H "Authorization: Bearer ecos_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" # Or use HttpOnly cookies (browser-based auth — set automatically on login) # Cookie: ecosire_auth=<jwt_token>