Adapty Mail API

v1.0.0
Download OpenAPI spec

Adapty Mail API を使用すると、Adapty SDK を経由せずに、サーバーから直接ユーザーのプロファイルとトランザクションイベントを Adapty Mail に送信できます。

用途:

  • Adapty Mail にまだベースがない場合にサブスクライバーを追加する。
  • 他のアプリのサブスクライバーベースを再利用する。
  • バックエンドをデータの信頼できる情報源として、Adapty Mail をサーバー間で連携させる。

メールアドレスを持つプロファイルは never purchased フローに対して十分です。その他のフロー(renewal cancelled、billing issue、expired、refunded)は購入履歴によって駆動されるため、それらのプロファイルには適切なフローに配置されるためのトランザクションイベントも必要です。

手順のウォークスルーについては、Adapty Mail API 経由でメールとトランザクションを送信する を参照してください。

Servers

  • https://api-mail.adapty.io — 本番サーバー

Authentication

Authorization

Type: apiKey · In: header

すべてのリクエストを Adapty Mail のシークレット API キーで認証してください。キーは Authorization ヘッダーに Bearer {your_secret_api_key} の形式(例: Bearer secret_live_...)で送信します。

このキーは Adapty Mail の Settings で確認できます。キーはプロジェクト固有であり、データが属するプロジェクトを識別するため、プロファイルエンドポイントとトランザクションエンドポイントにはプロジェクト ID は不要です。

curl --request GET \
  --url 'https://api-mail.adapty.io/...' \
  --header 'Authorization: Bearer YOUR_ADAPTY_MAIL_SECRET_API_KEY'

Operations