API概要

TWP公開APIを使用して、TWPで管理しているコンテンツや問い合わせ機能を外部のWebサイトやアプリケーションに統合できます。

提供API

ベースURL

https://{your-tenant}.api.tocca.systems

実際のURLはTWP管理画面のAPI設定からご確認いただけます。

APIの特徴

• RESTful API
• JSON形式のリクエスト/レスポンス
• APIキー認証
• レート制限あり
• CORS対応

認証方式

TWP公開APIは、APIキー認証を使用します。

X-API-Key: your_api_key_here

詳細は認証をご覧ください。

レスポンス形式

成功時

{
  "items": [...],
  "pagination": {
    "count": 10,
    "has_more": true
  }
}

エラー時

{
  "error": {
    "code": "ERROR_CODE",
    "message": "エラーメッセージ"
  }
}

HTTPステータスコード

レート制限

APIにはレート制限が設けられています。制限を超えた場合、429エラーが返されます。

API使用量の確認

API使用量はTWP管理画面の「組織設定」→「API使用量」から確認できます。

サポート

APIに関するお問い合わせは、TWP管理画面内のサポート機能からご連絡ください。