API概要

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

提供API

API	説明	主な用途
コンテンツAPI	コンテンツの取得・検索	コーポレートサイト、メディアサイト
問い合わせAPI	問い合わせの作成	お問い合わせフォーム


https://api.tocca.systems

テナントごとにURLが分かれることはありません。どのテナントのデータを返すかは、送ったAPIキーで決まります。

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


X-API-Key: your_api_key_here

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


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


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

APIキーが無い・無効な場合など、認証の段階で拒否されたときだけは形が異なり、403 と {"message": "Forbidden"} が返ります。詳しくはエラーコードをご覧ください。

コード	説明
200	成功
201	作成成功
400	リクエストエラー
401	プレビュートークンが無効（コンテンツAPIのみ）
403	認証エラー（APIキーが無い・無効・無効化済み・期限切れ）、権限不足、クレジット不足
404	リソースが見つからない
405	許可されていないHTTPメソッド
422	バリデーションエラー
429	リクエストが集中している
500	サーバーエラー

APIの呼び出しはテナントのクレジットを消費します。クレジット残高が不足すると、APIは 403 と error_code: "credit_exhausted" を返し、利用が一時停止されます。

プラン別の固定のリクエスト数上限は設けていません。ただし短時間にリクエストが集中した場合は 429（{"message": "Too Many Requests"}）が返ることがあります。その場合は間隔を空けてリトライしてください。

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

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