Getting Started

準備

本ページの内容は、下記3点がクリアされAkerun Proが使える状態となっていることを前提とします

・Akerun Proの利用申し込み

・Akerun Pro Starter Kitをドアに設置

・Akerun Manager で Akerun Pro がデバイス登録されていることを確認

アクセストークン取得までの流れ

1.redirect_urlの決定

OAuthのredirect_urlを弊社にお伝えください お問い合わせフォーム

2.client_id, crient_secretの用意

弊社から送付された、client_id, crient_secretを用意する

3.ログインフォームにて、Akerunユーザでログイン

下記urlにアクセス時に表示されるログインフォームにて、Akerunアカウントでログインする

https://api.akerun.com/oauth/authorize/?client_id=xxxx&redirect_uri=xxx&response_type=code

※Akerunの合鍵が発行されているアカウント、もしくはAkeurn Managerのマネージャー以上の権限を持っているアカウントでログインしない場合には、

 履歴が取得できませんのでご注意下さい。

4.認証コードの取得

ログイン後にredirect_urlに付与される認証コードを取得する

5.アクセストークンの取得

access_tokenの発行を行う

リクエスト例)

curl -F grant_type=authorization_code \
-F client_id=xxxx \
-F client_secret=xxxx \
-F code=xxxx \
-F redirect_uri=xxxx \
-X POST https://api.akerun.com/oauth/token

レスポンス例)

{“access_token”:”xxxx”,”token_type":"bearer","expires_in":7200,"created_at”:xxxx}

提供API一覧

1. 所有Akerun一覧API(/akeruns)

履歴取得する権限をもつakerunの一覧を取得できるAPI

2. 開閉履歴取得API(/accesses)

指定したAkerunの開閉履歴を取得できるAPI

所有Akerun一覧API

GET:  https://api.akerun.com/v2/external/akeruns

リクエストパラメータ

パラメータ名必須説明
access_tokenstring 

レスポンスパラメータ

パラメータ名繰返
successbooleanレスポンスの成否
akerunsarray
idstringAkerunのid
namestring部屋名
image_urlstring部屋の画像のurl

レスポンス例

{
  "success": true,
  "akeruns": [
    {
      "id”: "A-S000000001",
      “name”: “デモの部屋1”,
      "image_url": "https://room_image1.jpg"
    },
    {
      "id”: "A-S000000002",
      “name”: “デモの部屋2”,
      "image_url": “https://room_image2.jpg"
    },
    {
      "id": "A-S000000003",
      “name”: “デモの部屋3”,
      "image_url": “https://room_image3.jpg"
    }
  ]
}

開閉履歴取得API

GET:  https://api.akerun.com/v2/external/accesses

リクエストパラメータ

パラメータ名必須説明
akerun_idstring履歴を取得するakerunのid
offsetint履歴を取得する開始位置(デフォルト値 0)
limitint履歴の最大取得件数(デフォルト値 20)
fromdatetime履歴を取得する開始日時
tildatetime履歴を取得する終了日時
access_tokenstring 

レスポンスパラメータ

パラメータ名繰返
successbooleanレスポンスの成否
accessesarray
is_lockedboolean開閉状態(0: 解錠 1: 施錠)
client_typestring開閉方法(※ 下記に詳細)
created_atdatetime履歴の作成時刻
userhash開閉したユーザ情報
- idstringユーザID ※2017/07/26 追加
- full_namestringユーザ名
- mailstringメールアドレス
- image_urlstringユーザ画像URL
akerunhash開閉されたデバイス情報
- idstringAkerun ID
- namestringAkerun名
- image_urlstringAkerun画像URL

client_typeについて

パラメータ値説明
client_type=mobile_appiOSまたはandroidのアプリでの開閉履歴
client_type=managerWeb managerまたはurl鍵での開閉履歴
client_type=nfc_outsideドア外側からのNFC開閉履歴
client_type=nfc_insideドア内側からのNFC開閉履歴
client_type=autolockオートロックによる施錠履歴
client_type=hand手動による開閉履歴
client_type=buttonボタンによる開閉履歴

レスポンス例

{
  "success": true,
  "accesses": [
   {
      "is_locked": true,
      "client_type": "nfc_outside",
      "created_at": "2016-09-03T13:43:20.000Z”,
      "user": {
        "id": "U-00000-00001",
        "full_name": “テストユーザ1”,
        "mail": “test1@test.com"
        "image_url": ""
      },
      "akerun": {
        "id": "A-S000000001",
        "name": "デモの部屋1",
        "image_url": "https://room_image1.jpg"
      }
    },
    {
       "is_locked": false,
       "client_type": "manager",
       "created_at": "2016-09-02T00:14:59.000Z”,
       "user": {
         "id": "U-00000-00002",
         "full_name": “テストユーザ2”,
         "mail": “test2@test.com"
         "image_url": ""
       },
       "akerun": {
         "id": "A-S000000002",
         "name": "デモの部屋2",
         "image_url": "https://room_image2.jpg"
       }
    }]
}

FAQ

APIのリクエスト制限はありますか?

本APIにはリクエスト制限が設けられています。制限を超えたリクエストが行われた場合は、エラーが返却されます。

リクエスト制限値は、50リクエスト/分です。 これを超える利用を行いたい場合は、弊社サポートまでお問い合わせください。