MENU

はじめに

Akerun API (v2)の更新および新規利用受付は終了いたしました。

今後新しくAkerun APIをご利用を希望の方は、Akerun API (v3)をご利用ください。

現在Akerun API (v2)をご利用中の方は、引き続きAkerun API (v2)をご利用いただけますが、お早めにAkerun API (v3)に移行することをお勧めいたします。

Akerun API (v3)では入退室履歴の取得だけでなく、鍵の発行遠隔からの施錠・解錠など、数多くの機能をご利用いただけます。

APIバージョン

このページではAkerun API (v2)について説明しています。

最新バージョンのAkerun API (v3)については、こちらをご覧ください。

アクセストークン発行

Example Request

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

Example Response

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

1. authorization_codeの取得

Akerun API (v2)申込時にご記入頂いたredirect_uriと、申し込み後に弊社から送付されたclient_idを使用し、 下記URLにアクセスしてください。

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

ログインフォームが表示されますので、Akerunアカウントでログインしてください。

※Akerunの合鍵が発行されているアカウント、もしくはAkeurn Managerのマネージャー以上の権限を持っているアカウントでログインしない場合には、履歴が取得できませんのでご注意下さい。

ログイン後、authorization_coderedirect_uriに付与されます。

2. access_tokenを発行

申込時にご記入頂いたredirect_uriと、申し込み後に弊社から送付されたclient_id, client_secretと「1. authorization_codeの取得」で取得したauthorization_codeを使用し、Example Responseを参考にaccess_tokenの発行を行ってください。

所有Akerun一覧取得

Example Response

{
  "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"
    }
  ]
}

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

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

開閉履歴取得

Example Response

{
  "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"
       }
    }]
}

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

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

リクエストパラメータ

パラメータ名必須説明
access_tokenstring

レスポンスパラメータ

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

リクエストパラメータ

パラメータ名必須説明
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ボタンによる開閉履歴

リクエスト制限

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

リクエスト制限値は、50リクエスト/分です。 これを超える利用を行いたい場合は、 support@photosynth.co.jp までお問い合わせください。