WebAPI Client Specifications - STUDY-GRP/am-server GitHub Wiki
クライアント側はユーザーIDとパスワード「:」で繋ぎ、Base64エンコードしたものをAuthorizationヘッダに付加してリクエストを送信する。サーバー側は認証を行いレスポンスとしてアクセストークンを返す。
Request URL https://[hostname]/api/1.0/auth/access_token
HTTP Method POST
サンプルリクエスト
POST /api/1.0/auth/access_token HTTP/1.1
Host: [hostname]
Authorization:Basic bXlfdXNlcmlkOnBhc3N3b3Jk
Cache-Control:no-cache
Connection:keep-alive
:
:
サンプルレスポンス 成功時
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache
{
"header": {
"errorcode": "",
"message": ""
},
"body": {
"access_token": "9a811305e34a1630... ...2c9e39"
}
}
サンプルレスポンス エラー時
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache
{
"header": {
"errorcode": "PE00002",
"message": "ユーザー名または、パスワードが不適切ですs。"
},
"body": null
}
出社通知をサーバーに送信する。
リクエスト時にはアクセストークンをAuthorizationヘッダーに含む形で送信する。
Request URL https://[hostname]/api/1.0/attendance_time
HTTP Method POST
POST /api/1.0/attendance_time HTTP/1.1
Host: [hostname]
Authorization: Bearer ‹access_token›
サンプルレスポンス
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache
{
"header": {
"errorcode": "",
"message": ""
},
"body": null
}
サーバーに退社通知を送信する。
リクエスト時にはアクセストークンをAuthorizationヘッダーに含む形で送信する。
Request URL https://[hostname]/api/1.0/quitting_time
HTTP Method POST
サンプルリクエスト
POST /api/1.0/quitting_time HTTP/1.1
Host: [hostname]
Authorization: Bearer ‹access_token›
サンプルレスポンス
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache
{
"header": {
"errorcode": "",
"message": ""
},
"body": null
}