包括的な REST API との強力な統合を構築します。 818 以上のエンドポイント、完全な OpenAPI 仕様、および TypeScript SDK。
ECOSIRE API を数分で立ち上げて実行できます
Authentik または API キー経由で OAuth2 を使用して、API アクセス用の JWT ベアラー トークンを取得します。
Authorization ヘッダーのベアラー トークンを使用して、API エンドポイントを呼び出します。
TypeScript SDK をインストールすると、エラー処理が組み込まれたタイプセーフな API 呼び出しが可能になります。
企業運営のあらゆる側面をカバーする 57 のモジュールを探索する
統合ニーズに合わせた 2 つの認証方法
ブラウザ アプリケーションの安全な Cookie ベースの認証。トークンが JavaScript に公開されることはありません。
サーバー間の統合と API クライアントには JWT ベアラー トークンを使用します。
Try any endpoint directly from your browser. Select an endpoint, fill in parameters, and send live requests to the ECOSIRE API.
/auth/loginLogin with email and password
curl -X POST \ \
"https://api.ecosire.com/api/auth/login" \ \
-H "Content-Type: application/json" \
-d '{ "email": "[email protected]", "password": "secret" }'Install the ECOSIRE SDK in your language of choice and explore 6 common operations with full code snippets.
Choose your language and install the ECOSIRE SDK
npm install @ecosire/sdk6 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();ECOSIRE sends real-time webhook events to your server when key actions occur — payments, subscriptions, license activations, and more.
Explore all 8 webhook events, generate cURL commands, and verify HMAC signatures.
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.
{
"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 | |
invoice.paid | |
customer.subscription.deleted | |
customer.subscription.updated | |
charge.refunded | |
payment_intent.payment_failed | |
license.validated | |
license.activated |
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.
All API errors follow RFC 7807 (Problem Details for HTTP APIs). Every error includes a machine-readable code and human-readable message.
| Status | Meaning |
|---|---|
| 200 | OK |
| 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" }
]
}すべてのユーザーに 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 |
X-RateLimit-LimitMaximum requests allowed in the windowX-RateLimit-RemainingRequests remaining in the current windowX-RateLimit-ResetUnix timestamp when the window resetsRetry-AfterSeconds to wait before retrying (on 429)統合を構築するために必要なものすべて
Swagger UI インターフェイスを使用して、すべてのエンドポイントを探索してテストします。ブラウザから直接 API 呼び出しを試してください。
OpenAPI 3.0 の完全な仕様を JSON 形式でダウンロードします。 Postman、Insomnia、または独自のツールにインポートします。
オートコンプリート、エラー処理、および組み込みの再試行ロジックを備えたタイプセーフな API クライアント。
Create and manage API keys from your dashboard. Each key can be scoped to specific permissions and rotated independently.
Generate new API keys from Dashboard → Settings → API Keys. Each key has a name, optional expiry date, and role scope.
Keys can be scoped to read-only, read-write, or admin. Admin keys can manage other keys and access all endpoints.
Rotate keys at any time without downtime. The old key remains valid for 24 hours after rotation for a smooth transition.
View per-key request counts, error rates, and last-used timestamps from the API Keys dashboard page.
Maintain separate keys for development, staging, and production. Production keys log all requests for audit purposes.
Webhook endpoints also use a separate ECOSIRE_LICENSE_SECRET for HMAC-SHA256 signature verification on license events.
# 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>
ECOSIRE API に関するよくある質問
ECOSIRE アカウントにサインアップし、[ダッシュボード] > [API キー] に移動して API 認証情報を生成します。 API アクセスはすべてのプランで利用できます。
はい、すべての ECOSIRE アカウントには API アクセスが含まれています。レート制限はプランによって異なります。無料枠では、1 日あたり最大 1,000 件の API 呼び出しがサポートされます。
Authentik 経由の OAuth2 (Web アプリに推奨)、JWT ベアラー トークン (サーバー間)、および API キー (単純な統合用) をサポートしています。
はい、ECOSIRE はリアルタイムのイベント通知用の Webhook をサポートしています。 [ダッシュボード] > [設定] > [Webhook] で Webhook エンドポイントを構成します。
すべての API エンドポイントで 99.9% の稼働時間を維持します。ステータス ページとインシデント履歴は、status.ecosire.com でご覧いただけます。
API キーを取得して、数分で統合の構築を開始できます。