1 製品概要と利用方法
当製品の概要と利用方法について記載されています。
1.1 製品概要
本ドキュメントは、主に開発者の方々に利用いただくSenseLink CloudのAPIマニュアルです 。
SenseLink Cloudオープンプラットフォームは、SenseLink に基づくオープンサービスプラットフォームです。APIを利用することでサードパーティのシステムはSenseLinkからデバイス、登録者、レコードなどの情報を取得し、SenseLinkが持つ管理機能を統合することができるようになります。
1.2 Appキーの作成
SenseLinkにログインし、ヘッダーメニューの[ユーザー名]→[オープンプラットフォーム]を選択してください。Appキーを管理するオープンプラットフォーム画面が表示されます。
オープンプラットフォーム画面の、[App Keyを作る]ボタンをクリックしてください。
Appキーには、作成するキーごとに、APIの実行制限を設定することができます。
「制限する」にチェックを入れると、制限対象となるAPI名を選択できるプルダウンメニューが表示されます。制限したいAPIにチェックを入れてください。
「制限なし」にチェックを入れた場合は、APIの実行制限はありません。
以下のように、チェックボックスで指定することで、制限するAPIを指定できます。
選択後、確認のためにパスワードを入力する必要があります。表示される入力画面に現在ログイン中のアカウントのパスワードを入力して、確認ボタンをクリックしてください。
「AppキーとAppシークレットを作成しました。ダウンロードされたCSV内にAppキーとAppシークレットの情報が含まれます。安全に管理してください。」というメッセージが表示され、ご利用中のPCにAppキーとAppシークレットが記載されたCSVファイルがダウンロードされます。ダウンロードされたCSVファイルを開くと、AppキーとAppシークレットを確認することができます。
なお、入力したパスワードが誤っている場合、AppキーとAppシークレットは作成されず、CSVファイルもダウンロードされません。
1.2.1 Appキーの確認
Web画面上の一覧から、作成したAppキーとAppシークレットを確認することができます。Appシークレットはデフォルトで非表示になっています。表示ボタンをクリックすると、パスワード入力を求められます。
現在ログイン中のアカウントのパスワードを入力すると、Appシークレットが表示されます。
Appキーは「制限の変更」「無効」ができます。
1.2.2 特記事項” 列の追加
Appキーの一覧表示欄にある「特記事項」には、App Keyの用途などを記載できます。
特記事項欄には、最大30文字まで記入することができます。
1.2.3 Appキーの管理
Appキーは5つまで作成および利用可能で、無効化および削除することもできます。Appキーを一覧の設定ボタンを利用して適宜管理してください。無効化中はAppキーとAppシークレットが利用できませんが、有効化すると再度同じAppキーとAppシークレットを利用することができます。一度削除するとAppキーとAppシークレットを復元することはできませんので、ご注意ください。
Appキーは「制限の変更」「無効」ができます。
「制限」をクリックすると、制限のステータスを変更する画面が表示されます。
ドメイン管理機能は現在使用できません。使用しないでください。
1.3 呼び出し方法
1.3.1 シグネチャ(sign)の計算
計算方法は、
により計算されます。タイムスタンプおよびAppシークレットを利用してください。
例 :
timestamp:Unix 時間 (ミリ秒を含む13桁)
1.3.2 GET メソッドのインターフェース
sign、timestamp、および Appキー(app_key)の 3 つのパラメーターを、オプションパラメーターと共に次のようにリクエストしてください。
https://link.japancv.co.jp/api/v1/device?typeId=10&size=100&sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng×tamp=1477881215000
TypeId および size はオプションパラメーターです。サーバーは現在の timestamp をクライアント側からのリクエスト内の timestamp と比較し、その差が30 分以上の場合はエラーを返します。
1.3.3 POST メソッドのインターフェース
sign、timestamp、およびAppキー(app_key) の 3 つのパラメーターを、次のようにリクエストしてください。
https://link.japancv.co.jp/api/v3/device/update?sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng×tamp=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 | 部署または従業員が配下にあるため削除できません |
最終更新