Portal do desenvolvedor ECOSIRE

Crie integrações poderosas com nossa API REST abrangente. Mais de 818 endpoints, especificações OpenAPI completas e SDK TypeScript.

Veja a documentação da API Obtenha a chave API

818+

Terminais de API

Módulos

REST

Arquitetura

Locais suportados

API

Início rápido

Comece a usar a API ECOSIRE em minutos

Autenticar

Use OAuth2 por meio de chaves Authentik ou API para obter um token de portador JWT para acesso à API.

POST /api/auth/login

Faça sua primeira ligação

Use o token de portador no cabeçalho Authorization para chamar qualquer endpoint de API.

# Listar todos os contatos

curl -H "Authorization: Bearer $TOKEN" \

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

Chame um endpoint público

O catálogo de aplicativos é aberto: sem chave e sem nada para instalar. Qualquer cliente HTTP funciona.

const res = await fetch(

"https://api.ecosire.com/api/apps/platforms"

);

const platforms = await res.json();

57 Modules

Módulos API

Explore 57 módulos que cobrem todos os aspectos das operações empresariais

Núcleo

AuthUsersContactsProductsOrdersProjectsSettings

Finanças

AccountingSalesPurchaseBillingInvoicing

Operações

InventoryManufacturingPOSRentalPlanning

Recursos Humanos

EmployeesRecruitmentTime OffAttendanceExpensesPayrollAppraisals

Marketing e crescimento

Email MarketingEventsMarketing AutomationAnalyticsAffiliatesLoyalty

IA e automação

ECOSIRE AISelf-Evolving EngineContent GenerationSEO Scanner

Security

Autenticação

Dois métodos de autenticação para atender às suas necessidades de integração

Cookies somente HTTP

Autenticação segura baseada em cookies para aplicativos de navegador. Os tokens nunca são expostos ao JavaScript.

Automático com o aplicativo web
HttpOnly, Seguro, SameSite=Lax
Rotação de token de atualização de 7 dias

Token do Portador

Use tokens de portador JWT para integrações servidor a servidor e clientes API.

// 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": "user@example.com",   "password": "secret" }'

HTTP

Exemplos de código HTTP

Nada para instalar. Chame a API com o cliente HTTP que a sua linguagem já traz: cada requisição abaixo funciona na API em produção.

Exemplos de código

Catálogo, licenças e ferramentas de agentes, em curl, TypeScript, Python, PHP e Ruby

1. Listar as plataformas

Todas as plataformas do catálogo de aplicativos, com quantos aplicativos estão listados e quantos podem ser instalados hoje. Não é preciso chave.

curl -s "https://api.ecosire.com/api/apps/platforms" \
  -H "User-Agent: my-integration/1.0"

# 200 OK — no key needed
# [
#   { "platform": "odoo", "slug": "odoo", "label": "Odoo",
#     "appCount": <apps listed>, "sellableCount": <ready to install today> },
#   ...
# ]

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": "customer@company.com",
      "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

Limites de taxa

Limites de uso justo para garantir a estabilidade da API para todos os usuários

Ponto final	Limite de taxa
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

Recursos e SDK

Tudo que você precisa para construir sua integração

Referência da API

URL base, limites de taxa, formato de resposta e os endpoints de cada módulo, com exemplos de requisição e resposta.

Abrir Documentos

Guia de autenticação

Como autenticar com uma chave de API ou um token JWT Bearer, além de boas práticas de segurança.

Abrir Documentos

Referência de erros

Códigos de status HTTP, o formato das respostas de erro, cenários de erro comuns e boas práticas de tratamento.

Abrir Documentos

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

Perguntas frequentes

Perguntas comuns sobre a API ECOSIRE

Como obtenho acesso à API?

Cadastre-se para uma conta ECOSIRE e navegue até Dashboard > Chaves de API para gerar suas credenciais de API. O acesso à API está disponível em todos os planos.

Existe um nível gratuito?

Sim, todas as contas ECOSIRE incluem acesso API. Os limites de taxa variam de acordo com o plano. O nível gratuito suporta até 1.000 chamadas de API por dia.

Quais métodos de autenticação são suportados?

Oferecemos suporte a OAuth2 via Authentik (recomendado para aplicativos da web), tokens de portador JWT (para servidor a servidor) e chaves de API (para integrações simples).

Você tem suporte para webhook?

Sim, o ECOSIRE oferece suporte a webhooks para notificações de eventos em tempo real. Configure endpoints de webhook em Painel > Configurações > Webhooks.

Qual é o SLA de tempo de atividade da API?

Não publicamos uma percentagem de disponibilidade — publicamos o sistema que a sustenta. A API corre como um cluster redundante de várias instâncias com verificações de saúde, as versões são lançadas como recargas sem tempo de inatividade em vez de reinícios, e o estado do serviço em tempo real e o histórico de incidentes estão em status.ecosire.com. Os compromissos de resposta a incidentes são definidos no seu acordo de suporte, não num número de marketing.

Pronto para construir?

Obtenha sua chave de API e comece a criar integrações em minutos.

Obtenha a chave API Ver documentação