API キーを作成する
- Replier のアカウントメニューから「アカウントを管理 → 連携」を開きます。
- 「API キー」で「API キーを作成」を選びます。
- あとで見分けられる名前を入力し、アクセスを選んで「キーを作成」を選びます。
- キーをコピーします。キーが表示されるのはこのときだけです。
リクエストを送る
キーを bearer token としてhttps://api.usereplier.com/v1 に送ります。
id を使います。
エラー
拒否されたリクエストは、HTTP ステータスと次のような本文を返します。code は変わりません。message は英語の説明で、言い回しが変わることがあります。エラーによっては、選んだ投稿をすでに使っている自動化など、ほかの項目が付きます。
安全に再試行する
変更を伴うリクエストにはIdempotency-Key ヘッダーを付けられます。操作ごとに新しいランダムな値(UUID など)を送り、再試行では同じ値を送ります。同じ値で再試行すると最初の結果が返り、自動化が 2 つできたり返信が 2 回送られたりしません。返信できなかったコメントやメッセージへの返信、過去のコメントへの返信、単発オートメーションの返信の送信と、単発オートメーションの作成ではこのヘッダーが必須です。付けないと IDEMPOTENCY_KEY_REQUIRED で拒否されます。
expected_version で送ってください。そのあとに自動化が変更されていれば、VERSION_CONFLICT で拒否されます。自動化の削除では必須です。
API の変更
/v1 では、Replier は追加だけを行います。新しいエンドポイント、新しい任意のパラメーター、新しいレスポンス項目、状態や理由を表す項目の新しい値です。知らない項目や値は無視してください。既存のコードが動かなくなる変更は /v2 として出します。