ECOSIRE開発者ポータル

Q: どのような認証方法がサポートされていますか?

Authentik 経由の OAuth2 (Web アプリに推奨)、JWT ベアラー トークン (サーバー間)、および API キー (単純な統合用) をサポートしています。

包括的な REST API との強力な統合を構築します。 818 以上のエンドポイント、完全な OpenAPI 仕様、および TypeScript SDK。

API ドキュメントを表示する APIキーの取得

818+

APIエンドポイント

モジュール

REST

建築

サポートされているロケール

API

クイックスタート

ECOSIRE API を数分で立ち上げて実行できます

認証する

Authentik または API キー経由で OAuth2 を使用して、API アクセス用の JWT ベアラートークンを取得します。

POST /api/auth/login

初めて電話をかける

Authorization ヘッダーのベアラートークンを使用して、API エンドポイントを呼び出します。

# すべての連絡先をリストする

curl -H "Authorization: Bearer $TOKEN" \

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

公開エンドポイントを呼び出す

アプリカタログは公開されています。キーもインストールも不要で、どの HTTP クライアントでも利用できます。

const res = await fetch(

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

);

const platforms = await res.json();

57 Modules

APIモジュール

企業運営のあらゆる側面をカバーする 57 のモジュールを探索する

コア

AuthUsersContactsProductsOrdersProjectsSettings

金融

AccountingSalesPurchaseBillingInvoicing

運営

InventoryManufacturingPOSRentalPlanning

人事

EmployeesRecruitmentTime OffAttendanceExpensesPayrollAppraisals

マーケティングと成長

Email MarketingEventsMarketing AutomationAnalyticsAffiliatesLoyalty

AIとオートメーション

ECOSIRE AISelf-Evolving EngineContent GenerationSEO Scanner

Security

認証

統合ニーズに合わせた 2 つの認証方法

HttpOnly Cookie

ブラウザアプリケーションの安全な Cookie ベースの認証。トークンが JavaScript に公開されることはありません。

Webアプリケーションで自動化
HttpOnly、セキュア、SameSite=Lax
7 日間のリフレッシュトークンのローテーション

無記名トークン

サーバー間の統合と API クライアントには JWT ベアラートークンを使用します。

// 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

HTTP コード例

インストールは不要です。お使いの言語に標準で付属する HTTP クライアントで API を呼び出せます。以下のリクエストはすべて本番 API でそのまま動作します。

コード例

カタログ、ライセンス、エージェントツール — curl、TypeScript、Python、PHP、Ruby で掲載

1. プラットフォームを一覧する

アプリカタログのすべてのプラットフォームと、それぞれの掲載アプリ数、今日すぐにインストールできるアプリ数を取得します。キーは不要です。

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

レート制限

すべてのユーザーに API の安定性を確保するための公平な使用制限

エンドポイント	レート制限
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

リソースとSDK

統合を構築するために必要なものすべて

API リファレンス

ベース URL、レート制限、レスポンス形式、各モジュールのエンドポイントを、リクエストとレスポンスの例とともに掲載しています。

ドキュメントを開く

認証ガイド

API キーまたは JWT Bearer トークンで認証する方法と、セキュリティのベストプラクティス。

ドキュメントを開く

エラーリファレンス

HTTP ステータスコード、エラーレスポンスの形式、よくあるエラーの例、エラー処理のベストプラクティス。

ドキュメントを開く

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

よくある質問

ECOSIRE API に関するよくある質問

API アクセスを取得するにはどうすればよいですか?

ECOSIRE アカウントにサインアップし、[ダッシュボード] > [API キー] に移動して API 認証情報を生成します。 API アクセスはすべてのプランで利用できます。

無料利用枠はありますか?

はい、すべての ECOSIRE アカウントには API アクセスが含まれています。レート制限はプランによって異なります。無料枠では、1 日あたり最大 1,000 件の API 呼び出しがサポートされます。

どのような認証方法がサポートされていますか?

Authentik 経由の OAuth2 (Web アプリに推奨)、JWT ベアラートークン (サーバー間)、および API キー (単純な統合用) をサポートしています。

Webhook のサポートはありますか?

はい、ECOSIRE はリアルタイムのイベント通知用の Webhook をサポートしています。 [ダッシュボード] > [設定] > [Webhook] で Webhook エンドポイントを構成します。

API アップタイム SLA とは何ですか?

当社は稼働率のパーセンテージを公表せず、その裏側の仕組みを公開しています。API はヘルスチェックを備えた冗長なマルチインスタンス構成のクラスタで稼働し、リリースは再起動ではなく無停止リロードで反映されます。現在のサービス状態とインシデント履歴は status.ecosire.com でご覧いただけます。障害時の対応時間は、宣伝用の数値ではなく、お客様のサポート契約で定めます。

構築する準備はできましたか?

API キーを取得して、数分で統合の構築を開始できます。

APIキーの取得ドキュメントを見る