平素よりYOMELをご利用いただき、誠にありがとうございます。
2026年5月以前から提供しているREST API(以下「旧API」)とWebhook(以下「旧Webhook」)は、2026年12月28日をもって提供を終了いたします。引き続きご利用いただくには、終了日時までに、新しいREST API(以下「新API」)と新しいWebhook(以下「新Webhook」)への切り替えをお願いいたします。
新方式では、お客様側でWebhook URL・APIキーの管理や、ユーザー・グループ単位でのアクセス権限の管理が可能となり、より高いセキュリティを担保した状態で外部へのデータ連携を行えるようになります。
■切り替えが必要なお客様
次のいずれかに当てはまる場合、切り替えが必要です。
- 旧APIをご利用の場合:連携プログラムのリクエスト先URLに
/v1/public/が含まれています。 - 旧Webhookをご利用の場合:現在Webhookを受信しており、「スペース設定」>「API設定」画面に発行済みのWebhook設定がありません(送信先URLやトリガーの設定を、弊社営業担当へご依頼いただいた場合が該当します)。
ご利用状況が分からない場合は、問い合わせフォームよりお問い合わせください。
■1. スケジュール
- 新API・新Webhook:提供中です。終了日時までは、旧API・旧Webhookと並行してご利用いただけます。
- 旧API・旧Webhookの提供終了:2026年12月28日 24:00(JST)
終了日時を過ぎると、次のようになります。
- 旧API:終了日時以降、予告なく順次停止します。停止後は、旧APIへのリクエストは404エラーとなります。
- 旧Webhook:終了日時以降、予告なく順次停止します。停止後は送信されません。
■2. 切り替えの進め方
切り替えには、次の3者の作業が必要です。
| ご担当 | 作業 |
|---|---|
| スペース管理者 | 「API設定」画面でキーを発行し、対象グループを選択する |
| グループ管理者 ※スペース管理者とグループ管理者が分かれている場合のみ |
承認依頼を承認する |
| 開発ご担当者 | 連携プログラムと受信側の設定を修正し、動作を確認する |
承認はグループ管理者の対応を待つ必要があります。プログラムの修正より先に、キーの発行と承認依頼を進めてください。
次の場合は準備に時間がかかるため、早めにご確認ください。
- 旧Webhookを
http://のURLやプライベートIPアドレスで受信している場合:インターネットから到達可能なhttps://の受信先が必要です。 - スペースでIPアドレス制限を有効にしている場合:APIの接続元が許可対象に含まれているか、確認が必要です(詳細は「3. REST API:旧APIから変わる点」をご覧ください)。
承認の仕組み
| 項目 | 内容 |
|---|---|
| 複数のグループを選択した場合 | 承認されたグループの分から利用できます |
| 承認の操作 | グループ管理者が、「グループ管理」>「APIキー」画面から承認します |
| グループ管理者が承認できない場合 | スペース管理者を対象グループの管理者に設定した状態でキーを発行すると、自動で承認されます |
| 発行後のグループの追加 | 発行後も追加できます |
| 発行後に作成されたグループ | 自動では対象に含まれません |
■3. REST API:旧APIから変わる点
「必要な対応」に当てはまる項目は、連携プログラムや設定の修正が必要です。取得できるグループや件数の上限が変わるため、エラーが出なくても取得結果が変わる場合があります。
動作の変更
| 項目 | 旧API | 新API | 必要な対応 |
|---|---|---|---|
| URL | /v1/public/... |
/v2/public/... |
リクエスト先のURLを変更する |
| APIキー | これまでのキー | スペース管理者が「API設定」画面で発行し、グループ管理者が承認する。発行時に一度だけ表示される | 新しいキーを発行し、X-API-KEY ヘッダの値を差し替える(「4. REST API:切り替え手順」参照) |
| APIキーの有効期限 | なし | 発行時に有効期限を設定する(発行日から1年以内)。発行後は変更できない | 期限が切れる前にキーを入れ替える(「4. REST API:切り替え手順」参照) |
| 取得できるデータの範囲 | プライベートモードを除くスペース全体 | 承認済みグループのデータのみ。プライベートグループのデータは取得できない。対象外のグループを group パラメータで指定すると403エラー |
旧APIと同じ範囲を取得する場合は、すべてのグループを選択して発行する |
group パラメータを指定しない場合 |
全グループが対象 | 承認済みの全グループが対象 | 対応不要(group の指定は任意) |
ログ検索(logs/search)で per_page を指定しない場合 |
1回あたり最大10000件 | 1回あたり最大1000件 | 1000件を超える場合は page パラメータで続きを取得する |
| IPアドレス制限 | APIの接続元には適用されない | スペースでIPアドレス制限を有効にしている場合、APIの接続元にも適用される | 接続元のIPアドレスが許可対象に含まれているか確認する。接続元に固定のIPアドレスがない場合、IPアドレス制限は利用できない |
返却されなくなる項目
次の項目は、新APIでは返却されません。
| 対象のAPI | 返却されなくなる項目 |
|---|---|
| ログ(詳細・検索) |
overview, edit_version, need_llm_calibration, is_finalized_for_swap, finalize_completed_at
|
ユーザー(user_accounts) |
uid, client, email_for_notification, memo, profile, is_password_change_required, is_tutorial_completed, force_logout_at
|
グループ(groups) |
client, max_stt_usage_time, created_by, setting
|
要約(gpt-3/summary) |
encrypted_memo_for_daily_reports, encrypted_memo_for_points
|
ここまでの表に挙げた点を除き、リクエストのパラメータとレスポンスの形式は旧APIと同じです。ただし、一部のエラーでは、返されるステータスコードなどが変わります。エラーの内容で処理を分けている場合は、ご注意ください。
■4. REST API:切り替え手順
終了日時までは旧APIと新APIを並行して使えます。新APIの動作を確認してから、本番の連携を切り替えてください。
- スペース管理者が、スペース設定内の「API設定」画面でAPIキーを新規発行します。APIキーは発行時に一度だけ表示されますので、必ず控えてください。
- 選択したグループの管理者が、承認依頼を承認します。発行者がそのグループの管理者の場合は、自動で承認されます。
- 連携プログラムのURLを
/v1/public/...から/v2/public/...に変更し、X-API-KEYヘッダの値を新しいAPIキーに差し替えます。URLとAPIキーは同時に切り替えてください。 - 新APIへのリクエストを行い、正常にレスポンスが取得できることを確認してください。
切り戻し
終了日時までは、URLとAPIキーを元に戻すと旧APIに戻せます。新しいAPIキーを発行した後も、旧APIのキーは終了日時までご利用いただけます。
切り替え後のAPIキーの管理
新APIのキーは、有効期限を過ぎると使えなくなり、連携が止まります。「アラート送付先」を設定すると、期限の1か月前から、設定した通知先にアラートメールが届きます。期限が切れる前に、新しいキーへ入れ替えてください。
■5. Webhook:旧Webhookから変わる点
送信される内容(JSONの形式)とイベントの種類は、旧Webhookと変わりません。変わるのは次の点です。
| 項目 | 旧Webhook | 新Webhook | 必要な対応 |
|---|---|---|---|
| 設定方法 | お客様の画面からは変更できない | スペース管理者が「API設定」画面で設定し、グループ管理者が承認する | 新Webhookを設定する(「6. Webhook:切り替え手順」参照) |
| 送信されるイベントの範囲 | スペース全体 | 承認済みグループのイベントのみ | 必要に応じて対象グループを指定する |
| リダイレクト(301/302等) | 追従していた | 追従しない | 最終的な受信URLを直接設定する |
承認が完了する前に発生したイベントは、承認後も送信されません。
署名による送信元の検証
セキュリティトークンを設定すると、リクエストに署名ヘッダ(X-Webhook-Timestamp / X-Webhook-Nonce / X-Webhook-Signature)が付き、送信元の検証にご利用いただけます。
■6. Webhook:切り替え手順
新Webhookで受信できることを確認してから、旧Webhookの停止をご依頼ください。
- スペース管理者が、スペース設定内の「API設定」画面で種別「Webhook」のキーを新規作成し、送信先URL・対象イベント・対象グループなどを設定します。
- 選択したグループの管理者が、承認依頼を承認します。発行者がそのグループの管理者の場合は、自動で承認されます。
- 新Webhookで受信できることを確認します。
- 旧Webhookの停止を、弊社サポートまたは営業担当までご依頼ください。旧Webhookの設定は、お客様の画面からは変更いただけません。
停止のご依頼については、次のとおりです。
| 項目 | 内容 |
|---|---|
| ご依頼時にお知らせいただく情報 | スペース名 |
| 停止までの目安 | 3営業日以内 |
| 停止後の再開 | ご依頼いただければ再開できます |
※年末年始休暇に伴い、年内は2026年12月22日(火)まで受付となりますのでご了承くださいませ。
停止のご依頼がない場合も、旧Webhookは「1. スケジュール」に記載のとおり、終了日時以降に停止します。
二重送信について
新Webhookの設定から旧Webhookの停止までの間、新旧の両方に同じ送信先を設定していると、同じイベントが2回送信されます。新Webhookでの受信を確認後、お早めに手順4の停止をご依頼ください。
■7. 参考資料・お問い合わせ
新API・新Webhookの詳しい仕様は、サポートサイトを併せてご確認ください。
ご不明な点がございましたら、弊社サポートまたは営業担当までお問い合わせください。技術的なお問い合わせの際は、次の情報を添えていただくと確認がスムーズです。
- スペース名
- 事象が発生した日時
- リクエストしたURLと、返ってきたステータスコード・エラー本文
今後ともYOMELをよろしくお願いいたします。