プロトコル
HTTPS
フォーマット
JSON
文字コード
UTF-8
日時のフォーマット
| 区分 | フォーマット | 内容 |
| 日付 | YYYY-MM-DD | UTC変換されません。 月や日を省略した場合は01として処理されます。 2019 → 2019-01-01 2019-07 → 2019-07-01 2019-7-2 → 2019-07-02 |
| 時刻 | HH:MM:SS | UTC変換されません。 |
| 日時 | 【取得の時】 YYYY-MM-DDTHH:MM:SSZ | ・「YYYY-MM-DD」と「HH:MM:SS」の間の「T」、「HH:MM:SS」の後の「Z」は固定値。 |
| 日時 | 【登録や更新の時 】 YYYY-MM-DDTHH:MM:SS±HH:MM または YYYY-MM-DDTHH:MM:SSZ | ・「YYYY-MM-DD」と「HH:MM:SS」の間の「T」、「HH:MM:SS」の後の「Z」は固定値。 ・「±HH:MM」には、UTCとの時刻の差を指定。 |
認証
リクエストパラメーターにユーザーごとに発行された API キーを付加して認証する方式です。 リソースへのアクセス時に、発行されたAPI キーをパラメータ名 “key” として付加することで認証が行われます。 APIキーの発行はKirokuにログイン後、プロフィールの編集から行うことができます。
https://xxx.kiro-ku.com/api/v1/users/10?key=UqGCJexVeBP88WJQ0QZtr8mSEDtcQ78hfkzhmBw9QTC9Owb8qiyTjtsKgFKj6bFQ
レスポンス
HTTP ステータスコードが「 200 」であれば正常終了、それ以外はエラー終了です。エ ラー発生時にはエラー情報を含む JSON データがレスポンスのボディに設定されます。
{
"code": 1,
"message": "不正な値です"
}
| キー | 型 | 内容 |
| code | 数値 | エラーを特定する値。 |
| message | 文字列 | エラーメッセージ。 |
レスポンスヘッダ
正常終了したレスポンスに、以下のヘッダが含まれます（2023年12月より適用予定）。
| キー | 内容 |
| X-RateLimit-Limit | 1分間に受付可能な最大リクエスト数 |
| X-RateLimit-Remaining | X-RateLimit-Resetの間までに受付可能な残りのリクエスト数 |
| X-RateLimit-Reset | リクエスト数の計測がリセットされるまでの時間（秒） |