Akerun Developersへようこそ。

Akerun Developersは「Akerun入退室管理システム」を利用する開発者に向けて、Akerun APIについての情報を提供しています。

はじめに

Akerun APIでは、Akerunでの入退室履歴の取得や合鍵の発行、遠隔からの施錠・解錠など、Akerunの様々な機能を使うことができます。

Akerun APIを使って、Akerunをさらに便利に使いこなしましょう。

APIバージョン

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

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

お申し込み

API利用をご希望の方は営業担当までお問い合わせください。

リダイレクトURIについて

リダイレクトURIは、OAuth2.0のアクセストークンを発行するフローで必要となります。 詳しくはOAuth 2.0の仕様をご覧ください。

また、プロトコルはhttpsのみに制限していますので予めご了承下さい。

スコープについて

スコープ一覧から、OAuthアプリケーションに必要なスコープのリストをお送りください。通信暗号化方式はTLS1.2以降に対応しています。

指定するAkerun IDについて

各機器には固有の「ID」が割り振られています。Akerun Proの場合は「A〜」から始まるIDを、Akerun コントローラーの場合は「R〜」から始まるIDを指定してください。IDの確認方法はこちらをご覧ください。

リクエスト

Akerun API へのリクエストの文字エンコーディングはUTF-8のみに対応しています。

レスポンス

Akerun API のレスポンスはJSONオブジェクトを返しています。 文字エンコーディングはUTF-8です。

認証

Akerun API v3はOAuth 2.0の仕様に準拠しています。

認証コードの取得

認証コード取得URL

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

申込時に指定したredirect_uriと、弊社から送付されたclient_idを使い認証コード取得URLにアクセスし、表示されるログインフォームにて、Akerunアカウントでログインを行ってください。

ログイン後にredirect_uriに付与されるクエリパラメーターのcodeはアクセストークンの取得時に必要となります。 認証コードの有効期間は発行から30分です。有効期間が過ぎた場合、再度発行してください。

HTTP リクエスト

GET https://api.akerun.com/oauth/authorize/?client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&response_type=code

アクセストークンの作成

Example Request

curl -X POST "https://api.akerun.com/oauth/token" \
     -d grant_type=authorization_code \
     -d client_id=851a5415a3df3fcfc634364b947c5f3c6949683669625c4a4264b83a18981e27 \
     -d client_secret=2b3d5efe93c135a87f49a0b8440d523d160e9a5f8b008d9969a13e40191017da \
     -d code=c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252 \
     -d redirect_uri=https://akerun.com/

Example Response

{
  "access_token": "a8e144f4bac98c33814407999e5b1216b898b67605ae691f35beac7fb24ad39f",
  "token_type": "bearer",
  "refresh_token": "14ba1946cf8a3dg1fd3de49c4b2efe9e9c24d44efa64762bbc36e71edbffb424",
  "expires_in": 7776000,
  "created_at": 1500953017
}

API の利用にはアクセストークンが必要です。 Example Requestを参考にアクセストークンの作成を行なってください。

HTTP リクエスト

POST https://api.akerun.com/oauth/token

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

アクセストークンの再発行

Example Request

curl -X POST "https://api.akerun.com/oauth/token" \
     -d grant_type=refresh_token \
     -d client_id=851a5415a3df3fcfc634364b947c5f3c6949683669625c4a4264b83a18981e27 \
     -d client_secret=2b3d5efe93c135a87f49a0b8440d523d160e9a5f8b008d9969a13e40191017da \
     -d refresh_token=e6621710f55da19012bf7412a7675e654ca44351bd8659af41726c559d0cf848

Example Response

{
  "access_token": "56937ebdd4489cf705d4ec3be38c72d7d6789c0591e8c0c34a2ddcc75e8cd295",
  "token_type": "bearer",
  "refresh_token": "872eb483a170e2ecfeee9eea2db31543785cf48cfc4f39838238c94f363d582b",
  "expires_in": 7776000,
  "created_at": 1500953017
}

アクセストークンを再発行します。

アクセストークンの有効期間は発行から90日間です。期限が過ぎると、そのアクセストークンではAPIを利用することができなくなりますが、同時に発行されたリフレッシュトークンを使ってアクセストークンを再発行することができます。リフレッシュトークンの有効期限はありません。

アクセストークンの再発行は、アクセストークンの期限切れ前でも期限切れ後でも可能です。再発行したアクセストークンの有効期間は再発行した時点から90日間です。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

POST https://api.akerun.com/oauth/token

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

アクセストークンの無効化

Example Request

curl -X POST "https://api.akerun.com/oauth/revoke" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d client_id=851a5415a3df3fcfc634364b947c5f3c6949683669625c4a4264b83a18981e27 \
     -d client_secret=2b3d5efe93c135a87f49a0b8440d523d160e9a5f8b008d9969a13e40191017da \
     -d token=c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252

アクセストークンを無効化します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

POST https://api.akerun.com/oauth/revoke

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

無し

エラーレスポンス

アクセストークンの情報を取得

Example Request

curl -X GET "https://api.akerun.com/oauth/token/info" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252"

Example Response

{
  "application_name": "OAuth Application 1",
  "access_token": "45379971b810636443c20dcd7d06814e36bd4e100626f531184068af13fcc574",
  "refresh_token": "e6621710f55da19012bf7412a7675e654ca44351bd8659af41726c559d0cf848",
  "created_at": "2017-9-08T13:52:48Z",
  "expires_at": "2017-12-08T13:52:48Z"
}

アクセストークン の情報を取得します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET https://api.akerun.com/oauth/token/info

パラメータ

無し

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

OAuth スコープ

スコープについて

Photosynthがアプリケーションごとにアクセストークンを発行する際、お客様が申請されたスコープは全て有効状態となっています。必要なスコープはAPIのエンドポイントごとに異なり、不足している場合はエラーとなります。

スコープの一覧

API v3で使用されているスコープの一覧です。

スコープの設定

アクセストークンのスコープの設定は、アプリ連携を行った本人のみが行えます。

手順

1. Akerun Connectの「アカウント設定」ページから、アクセストークンを選択します。

1. アクセストークンに紐付いているアカウントと事業所一覧が表示されるので、スコープの操作をしたいアカウント、もしくは事業所の右側の「設定」を選択します。

1. 許可されたスコープにはチェックが入っております。もしチェックを外して「設定を更新する」を押すと対象のスコープは許可されなくなります。

事業所

事業所一覧

Example Request

curl -X GET "https://api.akerun.com/v3/organizations" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252"

Example Response

{
  "organizations": [
    {
      "id": "O-ab345-678ij"
    },
    {
      "id": "O-78924-45268"
    },
    {
      "id": "O-16542-60849"
    }
  ]
}

トークンオーナーが属する事業所IDを一覧で取得します。

事業所ID一覧はToken オーナーが事業所に属した順で返ります。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET https://api.akerun.com/v3/organizations

必要なスコープ

account:organization:read

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

事業所詳細

Example Request

curl -X GET "https://api.akerun.com/v3/organizations/O-ab345-678ij" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252"

Example Response

{
  "organization": {
    "id": "O-ab345-678ij",
    "name": "Photosynth"
  }
}

事業所の詳細情報を取得します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}

必要なスコープ

organization:read

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

ドア(Akerun)

ドア一覧

Example Request

curl -X GET "https://api.akerun.com/v3/organizations/O-ab345-678ij/akeruns" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d limit=100 \
     -d akerun_ids[]=A1030002 \
     -d akerun_ids[]=R1030002 \
     -d id_after=A1030002 \
     -d id_before=R1030002

Example Response

{
  "akeruns": [
    {
      "id": "A1030002",
      "model": "Pro",
      "name": "執務室表口",
      "image_url": "https://akerun.com/akerun_example1.jpg",
      "autolock": true,
      "seconds_till_autolock": 100,
      "autolock_off_schedule": {
        "days_of_week": [1,2,3,4,5],
        "start_time": "10:00+09:00",
        "end_time": "19:00+09:00",
        "is_holiday_enabled": true
      },
      "open_door_alert": true,
      "open_door_alert_second": 30,
      "push_button": false,
      "normal_sound_volume": 50,
      "alert_sound_volume": 100,
      "battery_percentage": 100,
      "lock_type": null,
      "unlock_signal_duration": null,
      "button1": null,
      "akerun_remote": {
        "id": "TG11100002"
      },
      "nfc_reader_inside": {
        "id": "NP0000001",
        "battery_percentage": 100
      },
      "npin_normal_sound_volume": 10,
      "npin_warning_sound_volume": 20,
      "nfc_reader_outside": {
        "id": "NP0000002",
        "battery_percentage": 100
      },
      "npout_normal_sound_volume": 30,
      "npout_warning_sound_volume": 40,
      "door_sensor": {
        "id": "W0000001",
        "battery_percentage": 100
      },
    },
    {
      "id": "R1030002",
      "model": "Ctl",
      "name": "執務室表口",
      "image_url": "https://akerun.com/akerun_example1.jpg",
      "autolock": true,
      "seconds_till_autolock": 100,
      "autolock_off_schedule": {
        "days_of_week": [1,2,3,4,5],
        "start_time": "10:00+09:00",
        "end_time": "19:00+09:00",
        "is_holiday_enabled": true
      },
      "open_door_alert": false,
      "open_door_alert_second": null,
      "push_button": true,
      "normal_sound_volume": null,
      "alert_sound_volume": null,
      "battery_percentage": null,
      "lock_type": "lock_in_energizing",
      "unlock_signal_duration": null,
      "button1": {
        "enabled": true,
        "days_of_week": [0, 1],
        "start_time": "10:00+09:00",
        "end_time": "19:00+09:00",
        "holiday_enabled": true,
      },
      "akerun_remote": {
        "id": "TG11100002"
      },
      "nfc_reader_inside": {
        "id": "NP0000001",
        "battery_percentage": 100
      },
      "npin_normal_sound_volume": 10,
      "npin_warning_sound_volume": 20,
      "nfc_reader_outside": {
        "id": "NP0000002",
        "battery_percentage": 100
      },
      "npout_normal_sound_volume": 30,
      "npout_warning_sound_volume": 40,
      "door_sensor": null
    }
  ]
}

事業所に属するAkerunの一覧を取得します。事業所に属した順で返ります。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/akeruns

必要なスコープ

organization:akerun:read

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

ドア詳細

Example Request

curl -X GET "https://api.akerun.com/v3/organizations/O-ab345-678ij/akeruns/A1030001" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252"

Ctl Example Response

{
  "akerun": {
    "id": "R1030002",
    "model": "Ctl",
    "name": "執務室表口",
    "image_url": "https://akerun.com/akerun_example1.jpg",
    "autolock": true,
    "seconds_till_autolock": 100,
    "autolock_off_schedule": {
      "days_of_week": [1,2,3,4,5],
      "start_time": "10:00+09:00",
      "end_time": "19:00+09:00",
      "is_holiday_enabled": true
    },
    "open_door_alert": false,
    "open_door_alert_second": null,
    "push_button": true,
    "normal_sound_volume": null,
    "alert_sound_volume": null,
    "battery_percentage": null,
    "lock_type": "lock_in_energizing",
    "unlock_signal_duration": null,
    "button1": {
      "enabled": true,
      "days_of_week": [0, 1],
      "start_time": "10:00+09:00",
      "end_time": "19:00+09:00",
      "holiday_enabled": true,
    },
    "akerun_remote": {
      "id": "TG11100002"
    },
    "nfc_reader_inside": {
      "id": "NP0000001",
      "battery_percentage": 100
    },
    "npin_normal_sound_volume": 10,
    "npin_warning_sound_volume": 20,
    "nfc_reader_outside": {
      "id": "NP0000002",
      "battery_percentage": 100
    },
    "npout_normal_sound_volume": 30,
    "npout_warning_sound_volume": 40,
    "door_sensor": null
  }
}

Pro Example Response

{
  "akerun": {
    "id": "A1030002",
    "model": "Pro",
    "name": "執務室表口",
    "image_url": "https://akerun.com/akerun_example1.jpg",
    "autolock": true,
    "seconds_till_autolock": 100,
    "autolock_off_schedule": {
      "days_of_week": [1,2,3,4,5],
      "start_time": "10:00+09:00",
      "end_time": "19:00+09:00",
      "is_holiday_enabled": true
    },
    "open_door_alert": true,
    "open_door_alert_second": 30,
    "push_button": false,
    "normal_sound_volume": 50,
    "alert_sound_volume": 100,
    "battery_percentage": 100,
    "lock_type": null,
    "unlock_signal_duration": null,
    "button1": null,
    "akerun_remote": {
      "id": "TG11100002"
    },
    "nfc_reader_inside": {
      "id": "NP0000001",
      "battery_percentage": 100
    },
    "npin_normal_sound_volume": 10,
    "npin_warning_sound_volume": 20,
    "nfc_reader_outside": {
      "id": "NP0000002",
      "battery_percentage": 100
    },
    "npout_normal_sound_volume": 30,
    "npout_warning_sound_volume": 40,
    "door_sensor": {
      "id": "W0000001",
      "battery_percentage": 100
    },
  }
}

事業所のAkerunの情報を取得します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/akeruns/{AKERUN_ID}

必要なスコープ

organization:akerun:read

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

ドア更新

Example Request

curl -X PUT "https://api.akerun.com/v3/organizations/O-ab345-678ij/akeruns/A1030001" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -F akerun_name=執務室表口 \
     -F akerun_image=@/path/to/image.jpg

Ctl Example Response

{
  "akerun": {
    "id": "R1030002",
    "model": "Ctl",
    "name": "執務室表口",
    "image_url": "https://akerun.com/akerun_example1.jpg",
    "autolock": true,
    "seconds_till_autolock": 100,
    "autolock_off_schedule": {
      "days_of_week": [1,2,3,4,5],
      "start_time": "10:00+09:00",
      "end_time": "19:00+09:00",
      "is_holiday_enabled": true
    },
    "open_door_alert": false,
    "open_door_alert_second": null,
    "push_button": true,
    "normal_sound_volume": null,
    "alert_sound_volume": null,
    "battery_percentage": null,
    "lock_type": "lock_in_energizing",
    "unlock_signal_duration": null,
    "button1": {
      "enabled": true,
      "days_of_week": [0, 1],
      "start_time": "10:00+09:00",
      "end_time": "19:00+09:00",
      "holiday_enabled": true,
    },
    "akerun_remote": {
      "id": "TG11100002"
    },
    "nfc_reader_inside": {
      "id": "NP0000001",
      "battery_percentage": 100
    },
    "npin_normal_sound_volume": 10,
    "npin_warning_sound_volume": 20,
    "nfc_reader_outside": {
      "id": "NP0000002",
      "battery_percentage": 100
    },
    "npout_normal_sound_volume": 30,
    "npout_warning_sound_volume": 40,
    "door_sensor": null
  }
}

Pro Example Response

{
  "akerun": {
    "id": "A1030002",
    "model": "Pro",
    "name": "執務室表口",
    "image_url": "https://akerun.com/akerun_example1.jpg",
    "autolock": true,
    "seconds_till_autolock": 100,
    "autolock_off_schedule": {
      "days_of_week": [1,2,3,4,5],
      "start_time": "10:00+09:00",
      "end_time": "19:00+09:00",
      "is_holiday_enabled": true
    },
    "open_door_alert": true,
    "open_door_alert_second": 30,
    "push_button": false,
    "normal_sound_volume": 50,
    "alert_sound_volume": 100,
    "battery_percentage": 100,
    "lock_type": null,
    "unlock_signal_duration": null,
    "button1": null,
    "akerun_remote": {
      "id": "TG11100002"
    },
    "nfc_reader_inside": {
      "id": "NP0000001",
      "battery_percentage": 100
    },
    "npin_normal_sound_volume": 10,
    "npin_warning_sound_volume": 20,
    "nfc_reader_outside": {
      "id": "NP0000002",
      "battery_percentage": 100
    },
    "npout_normal_sound_volume": 30,
    "npout_warning_sound_volume": 40,
    "door_sensor": {
      "id": "W0000001",
      "battery_percentage": 100
    },
  }
}

事業所のAkerunの情報を更新します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

PUT https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/akeruns/{AKERUN_ID}

必要なスコープ

organization:akerun:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

ドア(Akerun)グループ

ドアグループ一覧

Example Request

curl -X GET "https://api.akerun.com/v3/organizations/O-ab345-678ij/akerun_groups/" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252"

Example Response

{
  "akerun_groups": [
    {
      "id": "AG-12345-67890-09876",
      "name": "執務室",
      "memo": "カフェ側と廊下側の入り口をまとめています"
    },
    {
        "id": "AG-54321-09876-12345",
      "name": "会議室",
      "memo": "会議室をまとめています"
    }
  ]
}

事業所のAkerunグループ一覧を取得します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/akerun_groups/

必要なスコープ

organization:akerun_group:read

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

ドアグループ詳細

Example Request

curl -X GET "https://api.akerun.com/v3/organizations/O-ab345-678ij/akerun_groups/AG-12345-67890-09876" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252"

Example Response

{
  "akerun_group": {
    "id": "AG-12345-67890-09876",
    "name": "執務室",
    "memo": "カフェ側と廊下側の入り口をまとめています",
    "akeruns": [
      {
        "id": "A1030001",
        "name": "執務室表口",
        "image_url": "https://akerun.com/akerun_example1.jpg"
      }
    ]
  }
}

事業所のAkerunグループの詳細を取得します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/akerun_groups/{AKERUN_GROUP_ID}

必要なスコープ

organization:akerun_group:read

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

ドアグループ作成

Example Request

curl -X POST "https://api.akerun.com/v3/organizations/O-ab345-678ij/akerun_groups" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d name="執務室" \
     -d memo="カフェ側と廊下側の入り口をまとめています"

Example Response

{
  "akerun_group": {
      "id": "AG-12345-67890-09876",
      "name": "執務室",
      "memo": "カフェ側と廊下側の入り口をまとめています"
  }
}

事業所にAkerunグループを作成します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

POST https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/akerun_groups

必要なスコープ

organization:akerun_group:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 201

エラーレスポンス

ドアグループ更新

Example Request

curl -X PUT "https://api.akerun.com/v3/organizations/O-ab345-678ij/akerun_groups/AG-12345-67890-09876" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d name="執務室" \
     -d memo="カフェ側と廊下側の入り口をまとめています"

事業所のAkerunグループを更新します。

Example Response

{
  "akerun_group": {
      "id": "AG-12345-67890-09876",
      "name": "執務室",
      "memo": "カフェ側と廊下側の入り口をまとめています"
  }
}

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

PUT https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/akerun_groups/{AKERUN_GROUP_ID}

必要なスコープ

organization:akerun_group:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 201

エラーレスポンス

ドアグループ削除

Example Request

curl -X DELETE "https://api.akerun.com/v3/organizations/O-ab345-678ij/akerun_groups/AG-12345-67890-09876" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252"

事業所のAkerunグループを削除します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

DELETE https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/akerun_groups/{AKERUN_GROUP_ID}

必要なスコープ

organization:akerun_group:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 204

無し

エラーレスポンス

ドア追加

Example Request

curl -X POST "https://api.akerun.com/v3/organizations/O-ab345-678ij/akerun_groups/AG-12345-67890-09876/akeruns" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d akerun_ids[]=A1030001 \
     -d akerun_ids[]=A1030002

Example Response

{
  "akerun_group": {
      "id": "AG-12345-67890-09876",
      "name": "執務室",
      "memo": "カフェ側と廊下側の入り口をまとめています",
      "akeruns": [
          {
              "id": "A1030001",
              "name": "執務室カフェ側",
              "image_url": "https://akerun.com/akerun_example1.jpg"
          },
          {
              "id": "A1030002",
              "name": "執務室廊下側",
              "image_url": "https://akerun.com/akerun_example2.jpg"
          }
      ]
  }
}

事業所にAkerunグループにAkerunを追加します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

POST https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/akerun_groups/{AKERUN_GROUP_ID}/akeruns

必要なスコープ

organization:akerun_group:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 201

エラーレスポンス

ドア削除

Example Request

curl -X DELETE "https://api.akerun.com/v3/organizations/O-ab345-678ij/akerun_groups/AG-12345-67890-09876/akeruns" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d akerun_ids[]=A1030001 \
     -d akerun_ids[]=A1030002

事業所のAkerunグループにAkerunを削除します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

DELETE https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/akerun_groups/{AKERUN_GROUP_ID}/akeruns

必要なスコープ

organization:akerun_group:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 204

無し

エラーレスポンス

ユーザー

ユーザー一覧

Example Request

curl -X GET "https://api.akerun.com/v3/organizations/O-ab345-678ij/users" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d limit=100 \
     -d id_after=U-ab345-678ij \
     -d id_before=U-678ij-ab345 \
     -d user_code=1001 \
     -d include_datetime=true

Example Response

{
  "users": [
    {
      "id": "U-47891-98710",
      "name": "Photosynth太郎",
      "mail": "taro@akerun.com",
      "image_url": "https://akerun.com/user_example1.jpg",
      "authority": "manager",
      "code": "1001",
      "created_at": "2022-08-01T03:50:13Z",
      "updated_at": "2022-08-01T03:50:13Z",
      "nfcs": [
        {
          "id": "NA101010",
          "name": "アケルン太郎のICカード"
        }
      ]
    },
    {
      "id": "U-12562-69142",
      "name": "Photosynth太郎",
      "mail": "taro@akerun.com",
      "image_url": "https://akerun.com/user_example2.jpg",
      "authority": "manager",
      "code": "1001",
      "created_at": "2022-08-01T03:50:13Z",
      "updated_at": "2022-08-01T03:50:13Z",
      "nfcs": [
        {
          "id": "NA101010",
          "name": "Photosynth太郎のICカード"
        }
      ]
    }
  ]
}

Example Request

curl -X GET "https://api.akerun.com/v3/organizations/O-ab345-678ij/users" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d limit=100 \
     -d id_after=U-ab345-678ij \
     -d id_before=U-678ij-ab345 \
     -d user_mail=taro@akerun.com

Example Response

{
  "users": [
    {
      "id": "U-47891-98710",
      "name": "Photosynth太郎",
      "mail": "taro@akerun.com",
      "image_url": "https://akerun.com/user_example1.jpg",
      "authority": "manager",
      "code": "1001",
      "nfcs": [
        {
          "id": "NA101010",
          "name": "アケルン太郎のICカード"
        }
      ]
    }
  ]
}

事業所に属するユーザーの一覧を取得します。

ユーザー一覧は事業所に属した順で返ります。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/users

必要なスコープ

organization:user:read

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

(注)「更新日時」はユーザー名・ユーザーコード・メールアドレス・電話番号が更新された際やユーザーがAkerun Connectにログインした際に最新になります。

エラーレスポンス

ユーザー詳細

Example Request

curl -X GET "https://api.akerun.com/v3/organizations/O-ab345-678ij/users/U-ab345-678ij" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252"

Example Response

{
  "user": {
    "id": "U-ab345-678ij",
    "name": "Photosynth太郎",
    "mail": "taro@akerun.com",
    "image_url": "https://akerun.com/user_example1.jpg",
    "authority": "manager",
    "code": "1001",
    "nfcs": [
      {
        "id": "NA101010",
        "name": "Photosynth太郎のICカード"
      }
    ]
  }
}

事業所に属するユーザーの詳細を取得します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/users/{USER_ID}

必要なスコープ

organization:user:read

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

ユーザー登録

Example Request

curl -X POST "https://api.akerun.com/v3/organizations/O-ab345-678ij/users" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -F user_name=Photosynth太郎 \
     -F user_mail=taro@akerun.com \
     -F user_image=@/path/to/image.jpg \
     -F user_authority=manager \
     -F user_code='Akerun123'

Example Response

{
  "user": {
    "id": "U-ab345-678ij",
    "name": "Photosynth太郎",
    "mail": "taro@akerun.com",
    "image_url": "https://akerun.com/user_example1.jpg",
    "authority": "manager",
    "code": "Akerun123",
    "nfcs": [
      {
        "id": "NA101010",
        "name": "Photosynth太郎のICカード"
      }
    ]
  }
}

事業所に新規ユーザーを追加します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

POST https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/users

必要なスコープ

organization:user:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 201

エラーレスポンス

ユーザー招待

Example Request

curl -X POST "https://api.akerun.com/v3/organizations/O-ab345-678ij/users" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -F user_id=U-BAQt6-1QCMW \
     -F user_image=@/path/to/image.jpg \
     -F user_authority=manager \
     -F user_code='Akerun123'

Example Response

{
  "user": {
    "id": "U-BAQt6-1QCMW",
    "name": "Photosynth太郎",
    "mail": "taro@akerun.com",
    "image_url": "https://akerun.com/user_example1.jpg",
    "authority": "manager",
    "code": "Akerun123",
    "nfcs": [
      {
        "id": "NA101010",
        "name": "Photosynth太郎のICカード"
      }
    ]
  }
}

他事業所に所属しているユーザーを招待します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

POST https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/users

必要なスコープ

organization:user:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 201

エラーレスポンス

ユーザー更新

Example Request

curl -X PUT "https://api.akerun.com/v3/organizations/O-ab345-678ij/users/U-ab345-678ij" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -F user_name=Photosynth太郎 \
     -F user_mail=taro@akerun.com \
     -F user_image=@/path/to/image.jpg \
     -F user_authority=manager \
     -F user_code='Akerun456'

Example Response

{
  "user": {
    "id": "U-ab345-678ij",
    "name": "Photosynth太郎",
    "mail": "taro@akerun.com",
    "image_url": "https://akerun.com/user_example1.jpg",
    "authority": "manager",
    "code": "Akerun456",
    "nfcs": [
      {
        "id": "NA101010",
        "name": "Photosynth太郎のICカード"
      }
    ]
  }
}

事業所のユーザーの情報を更新します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

PUT https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/users/{USER_ID}

必要なスコープ

organization:user:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 201

エラーレスポンス

ユーザー退出

Example Request

curl -X DELETE "https://api.akerun.com/v3/organizations/O-ab345-678ij/users/U-ab345-678ij" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252"

事業所に属しているユーザーを退出させます。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

DELETE https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/users/{USER_ID}

必要なスコープ

organization:user:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 204

無し

エラーレスポンス

ユーザーグループ

ユーザーグループ一覧

Example Request

curl -X GET "https://api.akerun.com/v3/organizations/O-ab345-678ij/user_groups/" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252"

Example Response

{
  "user_groups": [
    {
      "id": "UG-12345-67890-09876",
      "name": "開発部",
      "memo": "開発部のユーザーをまとめています"
    },
    {
        "id": "UG-54321-09876-12345",
      "name": "営業部",
      "memo": "営業部のユーザーをまとめています"
    }
  ]
}

事業所のユーザーグループ一覧を取得します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/user_groups/

必要なスコープ

organization:user_group:read

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

ユーザーグループ詳細

Example Request

curl -X GET "https://api.akerun.com/v3/organizations/O-ab345-678ij/user_groups/UG-12345-67890-09876" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252"

Example Response

{
  "user_group": {
    "id": "UG-12345-67890-09876",
    "name": "開発部",
    "memo": "開発部のユーザーをまとめています",
    "users": [
      {
        "id": "U-47891-98710",
        "name": "Photosynth太郎",
        "image_url": "https://akerun.com/user_example1.jpg"
      }
    ]
  }
}

事業所のユーザーグループの詳細を取得します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/user_groups/{USER_GROUP_ID}

必要なスコープ

organization:user_group:read

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

ユーザーグループ作成

Example Request

curl -X POST "https://api.akerun.com/v3/organizations/O-ab345-678ij/user_groups" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d name="開発部" \
     -d memo="開発部のユーザーをまとめています"

Example Response

{
  "user_group": {
      "id": "UG-12345-67890-09876",
      "name": "開発部",
      "memo": "開発部のユーザーをまとめています"
  }
}

事業所にユーザーグループを作成します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

POST https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/user_groups

必要なスコープ

organization:user_group:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 201

エラーレスポンス

ユーザーグループ更新

Example Request

curl -X PUT "https://api.akerun.com/v3/organizations/O-ab345-678ij/user_groups/UG-12345-67890-09876" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d name="開発部" \
     -d memo="開発部のユーザーをまとめています"

事業所のユーザーグループを更新します。

Example Response

{
  "user_group": {
      "id": "AG-12345-67890-09876",
      "name": "開発部",
      "memo": "開発部のユーザーをまとめています"
  }
}

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

PUT https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/user_groups/{USER_GROUP_ID}

必要なスコープ

organization:user_group:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 201

エラーレスポンス

ユーザーグループ削除

Example Request

curl -X DELETE "https://api.akerun.com/v3/organizations/O-ab345-678ij/user_groups/UG-12345-67890-09876" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252"

事業所のユーザーグループを削除します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

DELETE https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/user_groups/{USER_GROUP_ID}

必要なスコープ

organization:user_group:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 204

無し

エラーレスポンス

ユーザー追加

Example Request

curl -X POST "https://api.akerun.com/v3/organizations/O-ab345-678ij/user_groups/UG-12345-67890-09876/users" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d user_ids[]=U-47891-98710 \
     -d user_ids[]=U-12562-69142

Example Response

{
  "user_group": {
      "id": "UG-12345-67890-09876",
      "name": "開発部",
      "memo": "開発部のユーザーをまとめています",
      "users": [
        {
          "id": "U-47891-98710",
          "name": "Photosynth太郎",
          "image_url": "https://akerun.com/user_example1.jpg"
        },
        {
          "id": "U-12562-69142",
          "name": "Photosynth太郎",
          "image_url": "https://akerun.com/user_example2.jpg"
        }
      ]
  }
}

事業所のユーザーグループにユーザーを追加します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

POST https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/user_groups/{USER_GROUP_ID}/users

必要なスコープ

organization:user_group:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 201

エラーレスポンス

ユーザー削除

Example Request

curl -X DELETE "https://api.akerun.com/v3/organizations/O-ab345-678ij/user_groups/UG-12345-67890-09876/users" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d user_ids[]=U-47891-98710 \
     -d user_ids[]=U-12562-69142

事業所のユーザーグループからユーザーを削除します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

DELETE https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/user_groups/{USER_GROUP_ID}/users

必要なスコープ

organization:user_group:write

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 204

無し

エラーレスポンス

合鍵

合鍵一覧

Example Request

curl -X GET "https://api.akerun.com/v3/organizations/O-ab345-678ij/keys" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d akerun_id=A1030001 \
     -d limit=100 \
     -d id_after=K-ab345-678ij \
     -d id_before=K-678ij-ab345

Example Response

{
  "keys": [
    {
      "id": "K-47891-98710-12mno",
      "role": "guest",
      "schedule_type": "recurring",
      "temporary_schedule": null,
      "recurring_schedule": {
        "days_of_week": [0, 1, 2, 3, 4, 5, 6],
        "start_time": "06:37+09:00",
        "end_time": "16:37+09:00"
      },
      "key_url": {
        "url": "https://keyurl.akerun.com/.....",
        "password_protected": true
      },
      "akerun": {
        "id": "A1030001",
        "name": "執務室表口"
      },
      "user": {
        "id": "U-ab345-678ij",
        "name": "アケルン太郎"
      }
    },
    {
      "id": "K-12562-69142",
      "role": "guest",
      "schedule_type": "temporary",
      "temporary_schedule": {
        "start_datetime": "2017-09-20T09:30+09:00",
        "end_datetime": "2017-09-22T18:00+09:00"
      },
      "recurring_schedule": null,
      "key_url": {
        "url": "https://keyurl.akerun.com/.....",
        "password_protected": true
      },
      "akerun": {
        "id": "A1030001",
        "name": "執務室表口"
      },
      "user": {
        "id": "U-678ij-ab345",
        "name": "Photosynth太郎"
      }
    }
  ]
}

事業所に属する合鍵の一覧を取得します。

合鍵一覧は発行した順で返ります。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/keys

必要なスコープ

organization:key:read

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

合鍵詳細

Example Request

curl -X GET "https://api.akerun.com/v3/organizations/O-ab345-678ij/keys/K-ab345-678ij-12mno" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252"

Example Response

{
  "key": {
    "id": "K-ab345-678ij-12mno",
    "role": "admin",
    "schedule_type": "recurring",
    "temporary_schedule": null,
    "recurring_schedule": {
      "days_of_week": [0, 1, 2, 3, 4, 5, 6],
      "start_time": "06:37+09:00",
      "end_time": "16:37+09:00"
    },
    "key_url": {
      "url": "https://keyurl.akerun.com/.....",
      "password_protected": true
    },
    "akerun": {
      "id": "A1030001",
      "name": "執務室表口"
    },
    "user": {
      "id": "A1030001",
      "name": "アケルン太郎"
    }
  }
}

事業所・ユーザー・Akerunの合鍵の一覧を取得します。

HTTP リクエストヘッダ

Authorization: Bearer {ACCESS_TOKEN}

HTTP リクエスト

GET https://api.akerun.com/v3/organizations/{ORGANIZATION_ID}/keys/{KEY_ID}

必要なスコープ

organization:key:read

パラメータ

(* 必須)

成功レスポンス

HTTP STATUS CODE: 200

エラーレスポンス

合鍵作成

Temporary Schedule Example Request

curl -X POST "https://api.akerun.com/v3/organizations/O-ab345-678ij/keys" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d user_id=U-ab345-678ij \
     -d akerun_id=A1030001 \
     -d schedule_type=temporary \
     --data-urlencode temporary_schedule[start_datetime]=2017-09-13T12:30+09:00 \
     --data-urlencode temporary_schedule[end_datetime]=2017-09-20T12:30+09:00 \
     -d role=guest

Temporary Schedule Example Response

{
  "key": {
    "id": "K-ab345-678ij-12mno",
    "role": "guest",
    "schedule_type": "temporary",
    "temporary_schedule": {
      "start_datetime": "2017-09-13T12:30+09:00",
      "end_datetime": "2017-09-20T12:30+09:00"
    },
    "recurring_schedule": null,
    "key_url": null,
    "akerun": {
      "id": "A1030001",
      "name": "執務室表口"
    },
    "user": {
      "id": "A1030001",
      "name": "アケルン太郎"
    }
  }
}

Recurring Schedule Example Request

curl -X POST "https://api.akerun.com/v3/organizations/O-ab345-678ij/keys" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d user_id=U-ab345-678ij \
     -d akerun_id=A1030001 \
     -d schedule_type=recurring \
     --data-urlencode recurring_schedule[start_time]=10:00+09:00 \
     --data-urlencode recurring_schedule[end_time]=19:00+09:00 \
     -d recurring_schedule[days_of_week][]=1 \
     -d recurring_schedule[days_of_week][]=2 \
     -d recurring_schedule[days_of_week][]=3 \
     -d recurring_schedule[days_of_week][]=4 \
     -d recurring_schedule[days_of_week][]=5 \
     -d role=guest

Recurring Schedule Example Response

{
  "key": {
    "id": "K-ab345-678ij",
    "role": "guest",
    "schedule_type": "recurring",
    "temporary_schedule": null,
    "recurring_schedule": {
      "days_of_week": [1,2,3,4,5],
      "start_time": "10:00+09:00",
      "end_time": "19:00+09:00"
    },
    "key_url": null,
    "akerun": {
      "id": "A1030001",
      "name": "執務室表口"
    },
    "user": {
      "id": "A1030001",
      "name": "アケルン太郎"
    }
  }
}

Always Schedule Example Request

curl -X POST "https://api.akerun.com/v3/organizations/O-ab345-678ij/keys" \
     -H "Authorization: Bearer c226b89bce98ebb8f6626be1bda25fb80ac56de6a1f7b3526cbad59e0e4af252" \
     -d user_id=U-ab345-678ij \
     -d akerun_id=A1030001 \
     -d schedule_type=always \
     -d role=guest

Always Schedule Example Response