操作可能者

管理者

💡API連携リリース以前（2026年5月以前）からREST API/Webhookをご利用のお客様へ
これまで試験的に提供しておりましたAPI連携機能を、正式リリースいたしました。
2026年5月以前からご利用いただいている「REST API/Webhook」および「APIドキュメント」については、
2026年内をめどに廃止を予定しております。
お手数ですが、管理者のAPI設定画面から新たにAPIキーまたはWebhookの設定・移行をお願いいたします。
なお、以前よりご利用いただいているAPIキー・Webhookの設定は、API設定画面には表示されない仕様です。
移行にあたり、以前から利用いただいているAPIの変更や廃止が必要な場合は、サポートまでお問い合わせください。

API連携について

YOMELから設定を行うことで、REST APIまたはWebhookによる外部サービスとのデータ連携が可能になります。

APIの詳細な仕様については、以下のドキュメントをご参照ください。

https://share.apidog.com/bf4a2b97-5126-4907-b447-9d191343b68d/doc-928108

APIキーの発行・管理、およびWebhookの設定は、「スペース設定>API設定」タブにて行うことができます。

新しいキーを作成する

画面内の［新しいAPIキーを作成］から、APIキーおよびWebhook設定の追加を行います。

1. APIキーを発行する

キーの作成画面で、各項目を以下のように設定してください。

設定項目	設定内容
キー種別	「API」を選択してください。
キー名	API設定画面にて表示するための、任意のキー名を設定してください。
対象グループ	APIでデータを取得したいグループを選択してください。（グループは複数選択可） ※プライベートモードは現在非対応となります。 ※設定を行った管理者がグループマネージャーとして参加していないグループを指定した場合、該当グループのグループマネージャーによる承認が必要となります。詳しくは「管理者が参加していないグループを指定する場合の注意」を参照ください。
有効期限	APIの有効期限を設定してください。（設定必須） ※設定可能な期限は発行日翌日から最大1年間となります。有効期限が切れるとAPIキーは利用できなくなります。 ※「アラート送付先」を設定すると、設定した通知先に、有効期限の1か月前からアラートメールが送信されます。
アラート送付先	有効期限のアラート通知を希望する場合は、受信したいメールアドレスを設定してください。

設定完了後、発行されたAPIキーが表示されます。

⚠️APIキーは発行直後の画面でしか確認できません。必ずその場でコピーして保存してください。
キーを紛失した場合、対象キーの右側メニューにある「キーコピー」機能（設定の複製）を使って、
新しいキーを再発行する必要があります。

API設定画面上では、設定した「キー名」と「キー末尾4桁」のみ確認できます。

2. Webhookキーを発行する

キーの作成画面で、各項目を以下のように設定してください。

設定項目	設定内容
キー種別	「Webhook」を選択してください。
キー名	API設定画面にて表示するための、任意のキー名を設定してください。
対象グループ	Webhookでデータを取得したいグループを選択してください。（グループは複数選択可） ※プライベートモードは現在非対応となります。 ※設定を行った管理者がグループマネージャーとして参加していないグループを指定した場合、該当グループのグループマネージャーによる承認が必要となります。詳しくは「管理者が参加していないグループを指定する場合の注意」を参照ください。
Webhook URL	Webhookの送信先となる、お客様のURLを指定してください。
セキュリティトークン	Webhook送信時、送信データがYOMELサービスからのものであることを証明するための共通鍵を設定できます。（設定は任意）
Webhookイベント	Webhookイベントを送信するトリガーを設定することが可能です。 ※詳細は以下のドキュメントをご参照ください。 https://share.apidog.com/bf4a2b97-5126-4907-b447-9d191343b68d/doc-928108

管理者が参加していないグループを指定する場合の注意

APIキーまたはWebhookの追加を行った管理者が、グループマネージャーとして参加していないグループを指定した場合、該当グループのグループマネージャーによる承認手続きが必要となります。

対象グループの「グループ設定画面>APIキー」タブに、グループマネージャーへのAPI承認依頼リクエストが表示されます。

承認依頼の承認・却下は、該当グループのグループマネージャーのみが行えます。

キーを発行した管理者が、該当グループのグループマネージャーの場合は、グループ設定からの承認を行う必要はなく、自動で承認されます。

設定の編集

発行済みのAPIキーおよびWebhookは、各キーの右側にある「三点リーダー（…）」メニューから操作・編集が可能です。

キー編集

キー種別、キー名、対象グループなどの変更を行えます。

※有効期限の変更は行えません。有効期限を迎えるキーの更新は「キーコピー」メニューから行ってください。
キーコピー

作成済みのキー設定を複製し、新しいキーを発行します。

コピー元のキーで承認されていたグループの権限をそのまま利用することができます。

※設定を行った管理者がグループマネージャーとして参加していないグループを新たに指定した場合、該当グループのグループマネージャーによる承認が必要となります。

詳しくは「管理者が参加していないグループを指定する場合の注意」を参照ください。
無効にする / 有効にする

作成済みのキーの無効化/有効化を行えます。
キー削除

作成済みのキーの削除を行えます。一度削除したキーは復元できませんのでご注意ください。

よくある質問

Q. 〇〇（外部サービス名）との連携は可能ですか？

A. 連携可否は、連携させたいサービス側の仕様により異なります。

YOMELのAPIでは「Webhook（Push型）」と「REST API形式（Pull型）」の2種類を提供しており、いずれかに対応しているサービスのみが連携可能な対象となります。

なお、個別サービスへの具体的な設定方法や連携実績などについてはお答えいたしかねますので、あらかじめご了承ください。

Q. 発行可能なAPIキー・Webhookの数に上限はありますか？

A. 発行数の上限はありません。必要な分だけ作成いただけます。

Q. APIキーを紛失してしまったが、再発行可能でしょうか？

A. 一度紛失したAPIキーを再度確認することはできません。

ただし、設定画面のメニューにある「キーコピー」機能を使って、現在の設定（グループ権限など）を引き継いだ「新しいキー」を複製・再発行することは可能です。

新しいキーが発行されたら、外部サービス側の設定を新しいキーへ差し替えてください。

Q. APIキーの有効期限を「なし（無期限）」にすることは可能ですか？

A. できません。

セキュリティ観点から、最長1年でのキーのローテーションを推奨しております。

Q. Webhookの場合、有効期限はありますか？

A. ありません。

Webhookは設定画面で無効化の操作をしない限りは、永続的に有効となります。

Q. プライベートモードのデータをAPIで取得することは可能ですか？

A. 現時点ではできません。

プライベートモードのAPI連携については、今後のアップデートでの提供を予定しております。

検索