概要
レコルWebAPIの仕様について説明します。
APIのURIやパラメータ等についてはレコルWebApiリファレンスをご確認ください。
APIのURIやパラメータ等についてはレコルWebApiリファレンスをご確認ください。
APIエンドポイント
https://api.recoru.in/
認証
レコルWebAPIを利用する場合はアクセストークンが必要です。アクセストークンは[契約情報]-[外部サービス連携]画面から発行できます。
※アクセストークンの発行はレコルの「サービス担当者」の利用者でログインする必要があります
リクエストヘッダに含めたアクセストークンを用いて認証を行います。
アクセストークンの発行については「レコルWebAPIの利用方法について」をご確認ください。
※アクセストークンの発行はレコルの「サービス担当者」の利用者でログインする必要があります
リクエストヘッダに含めたアクセストークンを用いて認証を行います。
アクセストークンの発行については「レコルWebAPIの利用方法について」をご確認ください。
Authorization: Bearer ACCESS_TOKEN
データフォーマット
データの送受信はJSON形式となります。
Content-Type: application/json
リクエスト制限
アクセストークン毎にリクエスト制限があります。
発行したアクセストークン毎に1時間に5000回まで、1秒間に5回までリクエストできます。
発行したアクセストークン毎に1時間に5000回まで、1秒間に5回までリクエストできます。
エラーレスポンス
APIリクエストでエラーが発生した場合、以下のエラーレスポンスを返します。
※HTTPステータスコードが404及び503の場合、エラーレスポンス(JSON形式)は返却しません
{
status: 400
type:"bad_request"
message: "パラメータが不正です"
}
status | type | 原因 |
---|---|---|
400 | bad_request | リクエストパラメータの内容が不正 |
401 | unauthorized | アクセストークンが無効 |
403 | forbidden | リソースへのアクセス権限なし |
422 | unprocessable_entity | APIの処理中にエラー発生(messageにエラー原因を返します) |
429 | too_many_requests | リクエスト制限の上限を超えた |
500 | service_unavailable | システム内部で予期せぬエラーが発生した |