API 概要

Perfex CRM SaaS Moduleには、SaaSプラットフォームをプログラムで管理できるREST APIが含まれています。次のような用途に便利です：

• カスタムサインアップページ — 独自の登録フローを構築
• サードパーティ統合 — 外部ツール（Zapier、Integromat、カスタムアプリ）と接続
• 請求の自動化 — 外部請求システムと同期
• 監視 — カスタムダッシュボードと監視ツールを構築
• モバイルアプリ — モバイル管理インターフェースを作成

APIの基本

ステップ1：APIを有効にする

1. SaaS Management → SuperAdmin Settingsに移動
2. API Settingsタブをクリック
3. APIをONに切り替え
4. APIトークンを生成

ステップ2：認証

すべてのAPIリクエストには、リクエストヘッダーのBearerトークンによる認証が必要です：

Authorization: Bearer YOUR_API_TOKEN_HERE

ステップ3：ベースURL

APIのベースURLは次のとおりです：

https://yoursite.com/api/saas/

yoursite.comを実際のドメインに置き換えてください。

---

クイック例

APIでテナントを作成する簡単な例：

curl -X POST https://yoursite.com/api/saas/tenants \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Acme Corp",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "plan_id": 1,
    "subdomain": "acme"
  }'

Response:

{
  "success": true,
  "tenant_id": 42,
  "domain": "acme.yoursite.com",
  "message": "Tenant created successfully"
}

---

API機能

エンドポイントグループ	できること
Tenants	テナントの作成、読み取り、更新、削除
Plans	プランの一覧表示、作成、更新
Subscriptions	テナントサブスクリプションの管理
Usage	テナントの使用量とクォータの照会

エンドポイントの完全なリストは、API Referenceを参照してください。

---

レート制限

APIはサーバー保護のためレート制限を実装しています：

• APIトークンあたり1分あたり100リクエスト
• レート制限ヘッダーはすべてのレスポンスに含まれます

レート制限を超えると、429 Too Many Requestsレスポンスが返されます。

---

ベストプラクティス

1. APIトークンを秘密に保つ — クライアントコードや公開リポジトリに公開しないでください
2. HTTPSを使用 — 常にHTTPS経由でAPIリクエストを行う
3. エラーを適切に処理 — レスポンスステータスコードを確認し、エラーを適切に処理する
4. 可能な場合はキャッシュ — 同じデータを繰り返し照会しない。変更が頻繁でない場合はレスポンスをキャッシュする

備考

カスタム統合が必要ですか？ APIがユースケースをカバーしていない場合は、supportからお問い合わせください。顧客のフィードバックに基づいてAPIを継続的に拡張しています。

API Reference