1 製品概要と利用方法
当製品の概要と利用方法について記載されています。
最終更新
当製品の概要と利用方法について記載されています。
最終更新
本ドキュメントは、主に開発者の方々に利用いただくSenseLink GE Enterprise、SenseLink GE Enterprise Pro、SenseLink CloudのAPIマニュアルです 。
SenseLink GE Open Platformは、SenseLink に基づくオープンサービスプラットフォームです。 サードパーティのシステムはSenseLinkからデバイス、登録者、レコードなどの情報を取得し、SenseLinkが持つ管理機能をすばやく統合できます。
SenseLink GE Enterprise/Enterprise ProにあるOpenAPIはドメイン名またはIPアクセスを制限せず、サーバーにアクセス可能なリクエストの全ては合法であると見なされます。
SenseLinkにログインし、ナビゲーションメニューの[システム管理] → [Open Platform] を選択してください。AppキーとAppシークレットを管理するOpen Platform画面が表示されます。
Open Platform画面の[App Keyを作る]ボタンをクリックしてください。確認のためにパスワードを入力する必要があります。表示される入力画面に現在ログイン中のアカウントのパスワードを入力して、確認ボタンをクリックしてください。
「AppキーとAppシークレットを作成しました。ダウンロードされたCSV内にAppキーとAppシークレットの情報が含まれます。安全に管理してください。」というメッセージが表示され、ご利用中のPCにAppキーとAppシークレットが記載されたCSVファイルがダウンロードされます。ダウンロードされたCSVファイルを開くと、AppキーとAppシークレットを確認することができます。 なお、入力したパスワードが誤っている場合、AppキーとAppシークレットは作成されず、CSVファイルもダウンロードされません。
またWeb画面上の一覧から、作成したAppキーとAppシークレットを確認することができます。Appシークレットはデフォルトで非表示になっています。表示ボタンをクリックすると、パスワード入力を求められます。現在ログイン中のアカウントのパスワードを入力すると、Appシークレットが表示されます。
登録したドメインからのみAPIを利用することができます。APIキーの作成後、Open Platform画面の[ドメインを追加]ボタンがアクティブになります。[ドメインを追加]ボタンをクリックし、必要なドメインを入力し、適用ボタンをクリックしてください。登録したドメインからAPIを利用できます。
Appキーは5つまで作成および利用いただくことができ、また無効化および削除することもできます。Appキーを一覧の設定ボタンを利用して適宜管理してください。 無効化中はAppキーとAppシークレットが利用できませんが、有効化するともう一度同じAppキーとAppシークレットを利用することができます。一度削除するとAppキーとAppシークレットを復元することはできませんので、ご注意ください。
計算方法は、
により計算されます。タイムスタンプおよびAppシークレットを利用してください。
例：
timestamp：Unix 時間 (ミリ秒を含む13桁)
sign、timestamp、および Appキー（app_key）の 3 つのパラメーターを、オプションパラメーターと共に次のようにリクエストしてください。
http://host:port/api/v1/device?typeId=10&size=100&sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng×tamp=1477881215000
TypeId および size はオプションパラメーターです。サーバーは現在の timestamp をクライアント側からのリクエスト内の timestamp と比較し、その差が30 分以上の場合はエラーを返します。
sign、timestamp、およびAppキー（app_key） の 3 つのパラメーターを、次のようにリクエストしてください。
http://host:port/api/v3/device/update?sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng×tamp=1477881215000
オプションパラメーターはリクエスト本体に配置され、form-data またはインターフェースドキュメントで指定された application/json に従って呼び出され、リクエストがサーバーへ送信されます。サーバーは現在の timestamp をクライアント側からのリクエスト内の timestamp と比較し、その差が30 分以上の場合はエラーを返します。
一部のインターフェースでは id をリクエストに配置する必要があります。詳細については、APIの利用方法をご参照ください。
コード | メッセージ | 原因 |
10001 | App Key Not Exist | キーがありません |
10002 | App Expired | キーが期限切れです |
10003 | Request Expired | リクエストが期限切れです |
10004 | IP Invalid | IPアドレスが許可リストにありません |
10005 | Signature Failed | 無効なシグネチャ（sign）です |
20001 | Company Out Of Date | 企業の利用期間の期限が切れました |
20002 | Permission Denied | 権限がありません |
30001 | Param Invalid | 無効なパラメーターです |
30002 | Similar User Exist | 追加された登録者は既存の登録者と非常に類似しています |
30003 | No Face Detected In The Image | 写真内で顔を検出できません |
30004 | Missing Param | パラメーターが不足しています |
30005 | Avatar File Invalid | 不正な写真形式です |
50001 | RPC Failed | サーバー同期エラー |
50002 | Internal Server Error | 内部サーバーエラー |
50003 | Multi Request Error | 一括リクエストエラー |
50004 | Request Method Not Allowed | 不正なリクエストメソッドです |
60005 | Request_rate_too_high | リクエスト頻度が高すぎます |
60006 | Daily_quota_exceeded | 1 日あたりのリクエスト上限に達しました |
99999 | Unknown Error | 不明なエラーです |
620 | Record non-existent Error | 不正なパラメーターです。対応するレコードが見つかりません |
610 | Similar record Exist | 類似するレコードが存在します（同じ名前の部署が同じレベルに存在するなど） |
650 | Cannot delete unless include nothing | 部署または従業員が配下にあるため削除できません |
