1 製品概要と利用方法

当製品の概要と利用方法について記載されています。

1.1 製品概要

本ドキュメントは、主に開発者の方々に利用いただくSenseLink GE EnterpriseのAPIマニュアルです 。

SenseLink GE Open Platformは、SenseLink に基づくオープンサービスプラットフォームです。 サードパーティのシステムはSenseLinkからデバイス、登録者、レコードなどの情報を取得し、SenseLinkが持つ管理機能をすばやく統合できます。

1.2 キーとシークレットの取得

SenseLinkにログインし、ナビゲーションメニューの[システム管理] → [Open Platform] を選択してください。AppキーとAppシークレットを管理するOpen Platform画面が表示されます。

1.2.1 キーとシークレットの作成と管理

AppキーやAppシークレットを作成するには、Open Platform画面の[App Keyを作る]ボタンをクリックしてください。このとき、確認のためにパスワードを入力する必要があります。表示される入力画面に現在ログイン中のアカウントのパスワードを入力して、確認ボタンをクリックしてください。

Open Platform画面

「AppキーとAppシークレットを作成しました。ダウンロードされたCSV内にAppキーとAppシークレットの情報が含まれます。安全に管理してください。」というメッセージが表示され、利用中のPCにAppキーとAppシークレットが記載されたCSVファイルがダウンロードされます。ダウンロードされたCSVファイルを開くと、AppキーとAppシークレットの内容を確認することができます。 なお、入力したパスワードが誤っている場合、AppキーとAppシークレットは作成されず、CSVファイルもダウンロードされません。

また、Web画面上の一覧から作成したAppキーとAppシークレットを確認することができます。Appシークレットはデフォルトで非表示になっています。表示ボタンをクリックすると、パスワード入力を求められます。現在ログイン中のアカウントのパスワードを入力すると、Appシークレットが表示されます。

Appシークレット表示ボタン

Appキーは5つまで作成および利用可能で、それぞれ無効化したり、削除もできます。一覧表示画面にある設定ボタンを利用することで管理できます。 無効化中はAppキーとAppシークレットが利用できませんが、有効化するともう一度同じAppキーとAppシークレットが利用可能です。ただし一度削除するとAppキーとAppシークレットを復元することはできませんので、ご注意ください。

1.2.2 ドメイン管理

APIは、第三者から不正アクセスを防止し、セキュリティを向上するため、登録したドメインからのみ利用可能となっています。 まず、OpenAPIアクセス制限設定を有効にしてください。詳細は運用マニュアルの4章をご参照ください。 APIキーを作成すると、Open Platform画面の[ドメインを追加]ボタンがアクティブになります。[ドメインを追加]ボタンをクリックして必要なドメインを入力し、適用ボタンをクリックしてください。登録したドメインからAPIを利用できます。

ドメイン追加ボタン

1.3 呼び出し方法

1.3.1 シグネチャ（sign）の計算

計算方法は、

sign=md5 (timestamp#app_secret)

により計算されます。タイムスタンプおよびAppシークレットを利用してください。

例：

app_secret=2323dsfadfewrasa3434
timestamp=1477881215000
sign=md5 (1477881215000#2323dsfadfewrasa3434) =e5ef72ef839bdf5397b4906b199b9fbf

timestamp：Unix 時間 (ミリ秒を含む13桁)

1.3.2 GET メソッドのインターフェース

sign、timestamp、および Appキー（app_key）の 3 つのパラメーターを、オプションパラメーターと共に次のようにリクエストしてください。

http://host:port/api/v1/device?typeId=10&size=100&sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng&timestamp=1477881215000

TypeId および size はオプションパラメーターです。サーバーは現在の timestamp をクライアント側からのリクエスト内の timestamp と比較し、その差が30 分以上の場合はエラーを返します。

1.3.3 POST メソッドのインターフェース

sign、timestamp、およびAppキー（app_key） の 3 つのパラメーターを、次のようにリクエストしてください。

http://host:port/api/v3/device/update?sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng&timestamp=1477881215000

オプションパラメーターはリクエスト本体に配置され、form-data　またはインターフェースドキュメントで指定された application/json に従って呼び出され、リクエストがサーバーへ送信されます。サーバーは現在の timestamp をクライアント側からのリクエスト内の timestamp と比較し、その差が30 分以上の場合はエラーを返します。

一部のインターフェースでは id をリクエストに配置する必要があります。詳細については、APIの利用方法をご参照ください。

1.4 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	部署または従業員が配下にあるため削除できません