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

店舗

連携リンクを作成する

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

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

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

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

認可

  • Authorizationstring必須

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

パスパラメーター

  • idstring必須

    店舗の ID。

ボディ

application/json

  • platformstring必須

    連携するネットワーク

    使用できる値: instagramfacebooktiktoklinkedinx

  • redirectUrlstring

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

レスポンス

201application/json

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

  • platformstring必須

    連携するネットワーク

  • urlstring必須

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

  • expiresAtstring必須

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

401

トークンがない、不明、期限切れ、または失効しています。

402

subscription_required。

403

テストアプリケーションの場合は live_mode_required、または accounts:write スコープがありません。

404

トークンの Workspace の外にある店舗。

409

account_already_connected:そのネットワークはすでに連携されています。

422

platform_not_offered:そのネットワークは提供されていません。

4XXapplication/json

その他のエラー。エラーエンベロープで返されます。