Nudgen API

プロダクトを Nudgen に接続

個人用アクセストークン認証によるREST API。連絡先、キャンペーン、テンプレート、設定をプログラムから管理できます。

本番アプリ

https://app.nudgen.com

PAT認証

標準のBearerヘッダーを使用した個人用アクセストークンによる認証。Nudgenダッシュボードで生成します。

クリーンなREST

標準的なHTTPメソッドとレスポンスコードを使用した、予測可能でリソース指向のURL。

レート制限

ワークフローを保護し公平性を確保するために、チームおよびエンドポイントごとにレート制限が組み込まれています。

安全なアクセス

設定 → API Keys で PAT を作成し、各リクエストに付与してください。

curl -X GET https://app.nudgen.com/api/v1/user/me \ -H "Authorization: Bearer <your-pat>"

APIリファレンス

アプリとエージェントが今日使えるリソース。

認証とID

現在認証されているユーザーを取得します。

GET/api/v1/user/me

現在のユーザーのすべてのチームを表示します。

GET/api/v1/teams

アクティブなチームコンテキストを切り替えます。

POST/api/v1/teams/switch

連絡先

ページネーション、検索、タグフィルターを使用して連絡先を表示します。

GET/api/v1/contacts

新しい連絡先を作成します。

POST/api/v1/contacts/add

特定の連絡先を取得します。

GET/api/v1/contacts/:id

既存の連絡先を更新します。

PATCH/api/v1/contacts/:id

連絡先を削除します。

DELETE/api/v1/contacts/:id

キャンペーン

現在のチームのキャンペーンを表示します。

GET/api/v1/campaigns

新しいキャンペーンを作成します。

POST/api/v1/campaigns

キャンペーンの詳細を取得します。

GET/api/v1/campaigns/:id

キャンペーンの配信統計を取得します。

GET/api/v1/campaigns/:id/stats

テンプレート

メールテンプレートを表示します。

GET/api/v1/templates

新しいメールテンプレートを作成します。

POST/api/v1/templates

設定

ブランド設定を取得します。

GET/api/v1/settings/brand

ブランド設定を更新します。

PATCH/api/v1/settings/brand