APIキー

EngageLabが提供するSMS送信APIを利用することで、プラットフォーム上で手動操作を行うことなく、SMS配信を自動化できます。APIキー管理ページでは、キーの一元的な作成、閲覧、削除をサポートしており、開発者が効率的かつ安全にSMSサービスを統合および管理できるようにします。

セキュリティに関する注意事項:
APIキーはSMSサービスAPIへのアクセスを許可します。安全に保管し、第三者と共有しないでください。

APIキーの作成

EngageLab SMS APIを使用してメッセージを送信する前に、API基本認証キーを作成する必要があります。
ページ右上の「APIキーを作成」ボタンをクリックして、キー作成ページに進みます。以下の情報を順に入力してください：

• APIキーの説明
  キーの用途を特定しやすくするために、カスタム説明を入力してください。これは参照用です。

• 有効期限（オプション）
  キーの有効期限を設定します。この日付を過ぎるとキーは自動的に無効になります。空欄の場合、キーは無期限で有効です。

• IPホワイトリスト（オプション）
  このキーを使用できるIPアドレスを制限します。本番環境ではセキュリティを強化するために設定を推奨します。複数のIPはカンマ（,）で区切ってください。空欄の場合、IP制限は適用されません。

フォームを入力後、「確認」ボタンをクリックしてください。システムは自動的にDevKeyとDevSecretを生成し、キーリストに表示します。

APIキーリスト

フィルターセクション

• あいまい検索

  • キーの説明やDevKeyのキーワードで素早く検索できます。

• ヘッダーフィルター

  • ドロップダウンオプションを使用して、キーのステータスでフィルタリングします。

• 時間フィルター

  • キーの有効期限でフィルタリングします。

• 複合フィルター

  • 複数の条件を使用してリアルタイムで結果をフィルタリングします。

フィールド説明

• DevSecretの表示/非表示

  • 秘密キーはデフォルトでアスタリスクで非表示になっています。ホバーすると平文を表示またはコピーでき、セキュリティを向上させます。

• ステータスの切り替え

  • ステータスはトグルボタンで制御されます。ホバーすると「オン/オフ」が表示され、クリックで有効と無効を切り替えます。無効化には誤操作を防ぐために確認が必要です。

    注意: キーステータスを切り替えた後は、すべての業務システムを更新して、ステータスの不一致によるエラーを防いでください。

キー詳細の表示

キーリストの任意の行をクリックすると、キー詳細ページに進み、完全な構成情報と操作ログを表示できます。

APIキーの編集

「編集」ボタンをクリックしてキー編集ページに進み、キーの説明、有効期限、IPホワイトリストの変更やDevSecretのリセットを行うことができます。

• DevSecretのリセット
  • 編集ポップアップ内で「リセット」をクリックすると、確認ダイアログが表示されます。確認後、システムは自動的に新しいDevSecretを生成します。
    

    リセット後、元のDevSecretは直ちに無効になります。新しいキーをすべての業務システムに迅速に更新してください。

キーの削除

キーを削除するには、「削除」ボタンをクリックし、アクションを確認して削除を完了します。

削除後、このキーはAPI呼び出しに使用できなくなります。削除前に、すべての業務システムがキーを置き換え、バックアップを取っていることを確認してください。