Poster Developer Documents
Introduction
Posterでは、会員サイトや顧客管理システムとのデータ連携を希望する開発者様向けにAPI/Webhook機能を提供しております。
API/WebhookはAPIプラン（月額12,800円）でご利用いただけますが、開発の検討や検証を目的としたご利用のために試用版を無料で提供しております。
API/Webhook機能を使用した連携開発やカスタマイズのご依頼は「サポートプランお問い合わせフォーム」よりご連絡下さい。
Poster API
LINEトーク画面から任意のウェブサイトへリンクする際のユーザー情報連携機能、及びユーザー連携時に取得したユーザーIDを使用した各種操作を行う事が出来ます。
共通仕様
APIリクエスト時の認証
APIの利用にはPoster管理画面よりAPIクライアントを作成して認証情報を取得する必要があります。
発行された認証情報をリクエストヘッダーに含めてアクセスする事でAPIを使用する事が出来ます。
APIクライアントはPoster管理画面にログインして対象のアカウントを選択した状態で、「外部システム連携」→「APIキー」→「APIキーを無料発行」と操作していただく事で作成可能です。
リクエストHeader
| X-POSTER-CLIENT-ID | Posterから発行された40文字の文字列 （Poster管理画面から確認して下さい。） |
|---|---|
| X-POSTER-CLIENT-SECRET | Posterから発行された80文字の文字列 （Poster管理画面から確認して下さい。） |
レスポンスHeader
| x-monthlylimit-limit | 月あたりのAPIリクエスト上限 （リクエスト上限数はご契約内容により異なります） |
|---|---|
| x-monthlylimit-remaining | 当月のリクエスト可能残数 |
| x-ratelimit-limit | 同一IPアドレスからの1分あたりのリクエスト上限 |
| x-ratelimit-remaining | x-ratelimit-limit に対する残りリクエスト可能数 |
Poster Webhook
特定のイベント（友だち登録など）が発生した際に予め設定したエンドポイントでイベントの通知を受け取る事ができます。
LINE Webhook を使用するLINE-botをPosterと併用する場合にも使用可能です。
共通仕様
署名の検証
受信したwebhookイベントがPosterから送信された正当なものである事を確認するため、必ず署名の検証を行って下さい。
- 発行された「webhook_key」を秘密鍵として、HMAC-SHA256アルゴリズムを使用してリクエストボディのダイジェスト値を取得します。
- ダイジェスト値をBase64エンコードした値と、リクエストヘッダーのX-Poster-Signatureに含まれる署名が一致することを確認します。
| 検証用の署名 | リクエストヘッダー「X-Poster-Signature」でbase64エンコードされた署名情報が送信されます。 |
|---|---|
| 署名検証用のキー（webhook_key） | Posterから発行された40文字の文字列 （Poster管理画面から確認して下さい。） |
