API リファレンス：アーキテクチャ、フィールド、ステータスコード

API アーキテクチャ

共通フィールド

コールバックと RESTful のすべてのリクエストは、次のトップレベルフィールドを共通で使用します。

テンプレートタイプ

生体データと認証情報は Template 配列で運ばれます。各項目には Type フィールドがあります：

レスポンスステータスコード

RESTful API のレスポンスには数値の StatusCode が含まれます。コールバック API のレスポンスは、結果にかかわらず常にシンプルな {"status":"done"} 形式です。

対応ポート

リアルタイムの勤怠情報を受信するには、サーバーで Cams Protocol Engine から到達可能な HTTP(S) エンドポイントを公開する必要があります。

サンプルデータ

全 38 操作のサンプルのリクエスト／レスポンスペイロードは、上記の各操作セクションに記載されています。まとめて確認する場合：

暗号化

オプションの AES-256 暗号化を有効にすると、Cams Protocol Engine とお客様のサーバー間でやり取りするすべてのデータを暗号化できます。

Java の例

// Encryption
Cipher cipher = Cipher.getInstance("AES/ECB/PKCS5PADDING");
SecretKeySpec keySpec = new SecretKeySpec(securityKey.getBytes("UTF-8"), "AES");
cipher.init(Cipher.ENCRYPT_MODE, keySpec);
String encrypted = Base64.getEncoder().encodeToString(cipher.doFinal(rawJson.getBytes("UTF-8")));

// Decryption
cipher.init(Cipher.DECRYPT_MODE, keySpec);
byte[] decoded = Base64.getDecoder().decode(encryptedPayload);
String decrypted = new String(cipher.doFinal(decoded), "UTF-8");