メインコンテンツへスキップ
Replier API を使うと、自分のコードや自動化ツールから Replier と同じ操作ができます。ワークスペース、接続済みアカウント、投稿の一覧、自動化の作成と変更、実績と連絡先の取得、返信できなかったコメントやメッセージへの返信や 単発オートメーションの返信の送信です。ChatGPT、Claude などの AI ツールから使う場合は、AI 接続を使ってください。 API リファレンス(英語)に、各エンドポイントのパラメーターとレスポンスがあります。

API キーを作成する

  1. Replier のアカウントメニューから「アカウントを管理 → 連携」を開きます。
  2. 「API キー」で「API キーを作成」を選びます。
  3. あとで見分けられる名前を入力し、アクセスを選んで「キーを作成」を選びます。
  4. キーをコピーします。キーが表示されるのはこのときだけです。
キーを持つ人は誰でも、あなたとして Replier を使えます。共有するコードやブラウザーには入れないでください。漏れた場合は、そのキーを削除して新しく作成します。 閲覧だけのキーは、変更しようとすると拒否されます。変更もできるキーは、自動化の作成・編集・オンとオフ・削除、既定のメッセージ文の保存、次の投稿キューの並べ替え、返信用写真のアップロード、返信できなかったコメントやメッセージへの返信と 単発オートメーションの返信の送信ができます。どちらのキーも各ワークスペースでのあなたの役割で動くため、あなたができる以上のことはできません。

リクエストを送る

キーを bearer token として https://api.usereplier.com/v1 に送ります。
ほかのリクエストはすべて、どれか 1 つのワークスペースで行います。上の一覧のワークスペース id を使います。
変更を伴うリクエストは JSON で送ります。
API で作成・変更する自動化にも、Replier と同じ上限があります。対象は最大 24 件、ボタンは 3 つ、写真は任意で 1 枚、メッセージフローは Studio ワークスペースだけです。

エラー

拒否されたリクエストは、HTTP ステータスと次のような本文を返します。
code は変わりません。message は英語の説明で、言い回しが変わることがあります。エラーによっては、選んだ投稿をすでに使っている自動化など、ほかの項目が付きます。

安全に再試行する

変更を伴うリクエストには Idempotency-Key ヘッダーを付けられます。操作ごとに新しいランダムな値(UUID など)を送り、再試行では同じ値を送ります。同じ値で再試行すると最初の結果が返り、自動化が 2 つできたり返信が 2 回送られたりしません。返信できなかったコメントやメッセージへの返信、過去のコメントへの返信、単発オートメーションの返信の送信と、単発オートメーションの作成ではこのヘッダーが必須です。付けないと IDEMPOTENCY_KEY_REQUIRED で拒否されます。
ほかの人の変更を上書きしないよう、読み取ったバージョンを expected_version で送ってください。そのあとに自動化が変更されていれば、VERSION_CONFLICT で拒否されます。自動化の削除では必須です。

API の変更

/v1 では、Replier は追加だけを行います。新しいエンドポイント、新しい任意のパラメーター、新しいレスポンス項目、状態や理由を表す項目の新しい値です。知らない項目や値は無視してください。既存のコードが動かなくなる変更は /v2 として出します。

キーを一時停止・削除する

「アカウントを管理 → 連携」では、各キーのアクセスと最後に使われた日時を確認できます。「アクセスを一時停止」を選ぶと、「アクセスを再開」を選ぶまでそのキーのリクエストは拒否されます。「キーを削除」を選ぶと完全に削除され、そのキーを使うコードはすぐにアクセスできなくなります。そのキーで作成した自動化は動き続けます。