店舗連携リンクを作成する

店舗

連携リンクを作成する

本人が Sofia でネットワークを認可するホスト型リンクを返し、ネットワークのトークンはアプリに渡りません。有効期間 30 分、ライブアプリのみ。

POSThttps://api.sofia-post.com/api/v1/establishments/{id}/connection-links
POSThttps://api.sofia-post.com/api/v1/establishments/{id}/connection-links

連携リンクを作成する

本人が Sofia でネットワークを認可するホスト型リンクを返し、ネットワークのトークンはアプリに渡りません。有効期間 30 分、ライブアプリのみ。

認可

Authorizationstring必須

個人キーまたは OAuth アクセストークン。Bearer <token> として送信します。

このタブ内にのみ保持され、api.sofia-post.com にのみ送信されます。 API キーを取得

パスパラメーター

idstring必須

店舗の ID。

ボディ

このリクエストは、実際のアカウントに対して実行されます。

ホスト型の接続リンクを作成し、オーナーをそこに案内します。リンクの有効期間は 30 分です。完了すると、Sofia は送信元を認識できる場合に、あなたの redirectUrl に戻します。

curl -X POST https://api.sofia-post.com/api/v1/establishments/$ESTABLISHMENT_ID/connection-links \
  -H "Authorization: Bearer $SOFIA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"platform":"linkedin","redirectUrl":"https://app.example.com/sofia/connected"}'

すでに接続済みのネットワークには 409 account_already_connected が、Sofia が提供していないネットワークには 422 platform_not_offered が返ります。

認可

  • Authorizationstringheader必須

    個人キーまたは OAuth アクセストークン。Bearer <token> として送信します。

パスパラメーター

  • idstring必須

    店舗の ID。

ボディ

application/json
  • platformstring必須

    連携するネットワーク

    使用できる値: instagramfacebooktiktoklinkedinx

  • redirectUrlstring

    最後に本人を移動させる先。Sofia がこのオリジンを認識した場合のみ。それ以外は Sofia のページが完了を知らせます

レスポンス

ホスト型の連携リンクと有効期限。

  • platformstring必須

    連携するネットワーク

  • urlstring必須

    本人がネットワークを連携するために開く Sofia のページ

  • expiresAtstring必須

    リンクがクリックを待つ期限(ISO 8601)

このページは役に立ちましたか?