はじめに

このAPIドキュメントはRe:port FlowのAPIドキュメントです。

Re:port Flowのサービスに関してはこちらを参照ください(https://lp.re-port-flow.com

  1. エンドポイント仕様

    1. ベースURL

      <aside>

      https://api.re-port-flow.com

      </aside>

    2. リクエストのコンテンツタイプ

      <aside>

      Content-Type: application/json

      </aside>

  2. 認証と認可

    1. 認証方式

      API の利用にはAPP_KEYとSECRET_KEYが必要です。

      ヘッダー名 値の説明
      X-APP-KEY APP_KEY
      X-SECRET-KEY SECRET_KEY
    2. APIキーの取得方法 はワークスペースの詳細画面から取得できます。

  3. APIリファレンス

    1. エンドポイント一覧

      エンドポイント一覧

  4. 制限事項

    1. レート制限

      1時間あたり5000回を超えるとリクエスト制限させていただきます。

      プランによって1ヶ月以内のファイル作成制限がございます。詳しくはプランを参照ください。

  5. エラーハンドリング

    1. エラーコード一覧

      HTTPステータス 原因
      400 リクエストパラメータの内容が不正
      401 指定したAPP_KEY,SECRET_KEYが無効
      403 リソースへのアクセスが禁止されている
      404 指定したリソースが存在しない
      500 システム内部で予期せぬエラーが発生した
      529 リクエスト制限の上限を超えた
      503 メンテナンスを行っています