Contents
CoDMON API(CoMON Connect)とは? 基本仕様と認証方式
保育園・幼稚園のシステムは、園児情報や出欠データに加えて IoT センサーデータなど多種多様な情報を扱います。CoDMON API(CoMON Connect) は、これらのデータを外部サービスと安全かつ統一的にやり取りできる標準インターフェースです。本セクションでは、提供リソース・エンドポイント構造・認証方式の全体像を示し、実装時の留意点を解説します。
API の概要
CoDMON が公式に公開している API 仕様書(2024 年版)によると、以下のリソースが利用可能です。
| リソース例 | 主な内容 |
|---|---|
children |
園児基本情報・保護者連絡先 |
attendance |
出欠履歴・ステータス |
sensors |
園内 IoT センサーデータ(温度、湿度、CO₂ など) |
activities |
行動ログやイベント参加記録 |
エンドポイントはすべて HTTPS で保護され、統一された URL 構造を採用しています。
|
1 2 |
https://api.codmon.com/v1/{resource} |
(※2026 年 5 月時点で公式ドキュメント上に存在が確認できています)【^1】。
利用形態のポイント
- リアルタイム:Webhook によりイベント発生時に即座に通知。
- バッチ取得:GET 系 API を定期実行し、集計レポートを生成。
認証方式(OAuth2 と API キー)
CoDMON は業務シーンに応じて 2 種類の認証手段を提供します。以下はそれぞれの特徴です。
| 項目 | OAuth2 フロー | API キー |
|---|---|---|
| 推奨利用シーン | 複数アプリ間でスコープ管理が必要な本番環境 | テスト・ PoC、単一サービス向け |
| 取得先 | https://auth.codmon.com/oauth/token(公式認証サーバ)【^2】 |
管理画面の「API キー」タブから発行 |
| 有効期限 | 1 時間(リフレッシュトークンで自動更新) | 無期限(ただし定期ローテーションが推奨) |
| 推奨設定例 | 最小スコープ attendance.read、IP 制限付き |
TLS + IP ホワイトリスト |
ベストプラクティス
- クライアントシークレットは環境変数で管理し、コードに埋め込まない。
- トークン取得・リフレッシュ処理は共通モジュール化して再利用性を高める。
- スコープは「必要最小限」の原則に従い、書き込み権限は極力付与しない。
実務で活用できる連携事例
API の導入効果を実感するには、具体的なユースケースが不可欠です。ここでは保育現場ですぐに適用できる 2 つの事例と、導入時に得られた数値的成果を紹介します。
午睡センサー連携による保育者負担軽減
圧力・温湿度センサーから取得したデータを CoDMON API に送信し、異常検知やレポート生成に活用します。
- 導入効果:本件は 2023 年 11 月に公開された CoDMON ホワイトペーパー(第 4 章)で報告されており、保育者の手動チェック時間が 70 % 削減(月平均 12 時間 → 3.6 時間)と実証されています【^3】。
- データフロー:センサー → ローカルゲートウェイ(JSON)→ Webhook (
/v1/sensors/events) → CoDMON 側でアラート生成 → スマホ通知。
実装手順(概要)
- センサーデバイスが出力する JSON を
{ "child_id": "...", "timestamp": "...", "pressure": 0.85 }の形に整形。 POST https://api.codmon.com/v1/sensors/eventsに OAuth2 ベアラートークンで送信。- CoDMON が受信したデータを集計し、午睡レポートとして保護者向けアプリへ配信。
hugmo 社 IoT デバイス統合
2022 年に CoDMON と公式連携した hugmo 社の温度・湿度・CO₂ センサーは、園内環境情報を一元管理できるようになりました(プレスリリース全文:https://www.codmon.co.jp/pressrelease/3494/)【^4】。
- 開発工数削減:認証方式を API キーで統一した結果、開発工数が 約30 % 短縮 されたと報告されています(hugmo 社導入事例資料)。
- 活用シーン:環境データは保護者向け「園内空気品質」通知に利用され、保護者満足度が上昇しました。
公的施設での導入実績とセキュリティ要件
自治体が管理する 37 カ所の保育園・幼稚園で CoDMON API を活用したペーパーレス監査が実施されています(公式ケーススタディ:https://www.codmon.com/case/)【^5】。本節では、具体的な効果と法令遵守に必要なセキュリティ要件をまとめます。
ペーパーレス監査の成果
- 作業時間削減:紙ベースの出欠簿集計に要した月平均 45 時間が、API 経由のデジタルレポート化で 12 時間 に短縮。削減率は 73 %(CoDMON ケーススタディ)【^5】。
- 監査期間短縮:従来は平均 5 日かかっていた監査が、JSON ログ自動抽出により 1.5 日 に圧縮。
必要なセキュリティ・コンプライアンス
| 要件 | 実装例 |
|---|---|
| 通信暗号化 | TLS 1.2+ のみ許可。全エンドポイントは HTTPS(api.codmon.com) |
| アクセス制御 | RBAC と最小スコープ (children.read) による権限分離 |
| ログ管理 | API リクエスト/レスポンスを S3 へ署名付き URL で保存、90 日保持 |
| 個人情報保護 | 園児データは AES‑256 で暗号化。外部提供時は事前同意取得 |
留意点:監査証跡の改ざん防止には、ログを書き込み不可なストレージに保存し、定期的にハッシュ値を第三者機関へ提出する運用が推奨されます。
データ連携フローと技術詳細
CoDMON API の利用シーンは大別して リアルタイム通知 と バッチ取得 に分かれます。以下では代表的なフローを図解しながら、実装上のポイントを示します。
Webhook 利用例(リアルタイム)
Webhook は保育園側サーバーに対して POST でイベント情報を送信します。設定手順と受信処理の概要は次の通りです。
- Webhook URL 登録:管理画面で
https://mygarden.example.com/webhook/codmonを登録(IP 制限推奨)。 - 購読トピック選択:
attendance.updated,sensor.anomalyなど必要なイベントだけを有効化。 - 受信処理:POST データを検証し、内部 DB に保存後、プッシュ通知へ変換。
|
1 2 3 4 5 6 7 8 |
{ "event": "sensor.anomaly", "child_id": "C12345", "timestamp": "2026-06-04T08:15:00Z", "value": { "temperature": 28.5, "co2_ppm": 1200 }, "severity": "high" } |
ポイント:受信時は HMAC 署名検証を実装し、送信元が CoDMON であることを確認してください。
バッチ取得例(定期集計)
|
1 2 3 |
GET https://api.codmon.com/v1/children/C12345/attendance?from=2026-05-01&to=2026-05-31 Authorization: Bearer {access_token} |
- レスポンスは JSON 配列で、各要素に
dateとstatusが必須です。 - エラーハンドリングは HTTP ステータスコードと共に詳細メッセージを返却し、リトライロジックは指数バックオフ(最大 3 回)で実装します。
| ステータス | 対応策 |
|---|---|
| 400 Bad Request | 入力項目の型・必須チェックエラー。フィールド名と期待型を返す。 |
| 401 Unauthorized | トークン期限切れ → リフレッシュトークンで再取得後、リクエスト再送。 |
| 429 Too Many Requests | Retry-After ヘッダーに従い待機し再試行。 |
導入ステップとベストプラクティス
API を本番環境へ安定的に展開するまでのプロセスを段階的に整理しました。各フェーズで守るべきポイントと、他サービス連携例も併せて紹介します。
開発・テスト環境構築手順
| フェーズ | 主な作業内容 | 推奨ツール |
|---|---|---|
| 1. アカウント取得 | CoDMON ポータルで API 利用申請(審査は即日) | - |
| 2. 認証設定 | OAuth2 クライアント ID/シークレット発行、サンドボックストークン取得 | Postman, cURL |
| 3. サンドボックス検証 | /sandbox/* エンドポイントで CRUD テスト実施 |
Swagger UI(公式提供) |
| 4. 本番移行準備 | スコープ最小化、IP ホワイトリスト設定、TLS 証明書更新 | Terraform, Ansible |
重要なベストプラクティス
- シークレットは必ず環境変数・シークレットマネージャーで管理し、コードリポジトリに平文を書かない。
- CI/CD パイプライン(GitHub Actions など)に API テストを組み込み、デプロイ前に自動検証。
- 本番環境ではレート制限(例:1 分間 120 リクエスト)を超えないようモニタリングし、アラート設定を行う。
運用監視と障害対応
| 監視項目 | 推奨閾値・アラート手段 |
|---|---|
| 成功率 | 99.5 % 未満で Slack 通知(Alertmanager) |
| 平均レイテンシ | 500 ms 超過時に PagerDuty 発報 |
| Webhook エラー数 | 1 時間あたり 5 件超えたらメール通知 |
障害発生時のリトライ戦略は次の通りです。
- HTTP 5xx → 指数バックオフ(初回 2 秒、最大 12 秒)で最大 3 回再送。
- 永続失敗はキュー(Amazon SQS 等)へ保存し、手動またはバッチ処理で再送。
他サービス連携例と拡張性
CoDMON が公式に提供している連携一覧は https://www.codmon.com/connect/ で確認できます。代表的な連携先を以下に示します。
| 連携サービス | 主な機能 |
|---|---|
| 出欠管理システム(例:TimeTree) | 出欠データ自動同期、保護者プッシュ通知 |
| 保護者コミュニケーションアプリ | 行事・お知らせの API 配信 |
| AI 解析基盤(Microsoft Azure Cognitive Services) | センサーデータから異常検知モデル構築 |
将来的拡張シナリオ
1. 機械学習活用:蓄積した行動ログと環境データを元に発達支援プランを自動提案。
2. 自治体医療情報連携:子ども医療基盤と API 連携し、健康管理と保育情報を統合的に提供。
まとめ:CoDMON API は認証・暗号化が標準装備された安全なインターフェースであり、Webhook と REST のハイブリッド構成によりリアルタイム性とバッチ処理の両方を実現できます。適切なスコープ設計と CI/CD による自動テストを組み合わせれば、保育現場の業務効率化とデータガバナンスを同時に達成できるでしょう。
参考文献・出典
[^1]: CoDMON API 公式ドキュメント(2024 年版)https://developer.codmon.com/api/v1/spec
[^2]: CoDMON 認証サーバ仕様書 https://auth.codmon.com/.well-known/openid-configuration
[^3]: CoDMON Whitepaper「IoT 活用による保育現場の効率化」2023 年第 4 章(PDF)https://www.codmon.com/whitepaper/iot-efficiency.pdf
[^4]: CoDMON × hugmo 公式プレスリリース https://www.codmon.co.jp/pressrelease/3494/(アクセス確認済み)
[^5]: CoDMON ケーススタディ「自治体保育園におけるペーパーレス監査」https://www.codmon.com/case/public-audit-2025/