メディアを取り込む

ファイル（multipart）か https URL を店舗のメディアライブラリに追加します。ライブアプリと有効な購読が必要です。

POSThttps://api.sofia-post.com/api/v1/media

POST/v1/media

API キーまたはアクセストークンこのタブ内にのみ保持され、api.sofia-post.com にのみ送信されます。Idempotency-Key (header)リクエストボディ

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

curl -X POST 'https://api.sofia-post.com/api/v1/media' \
  -H "Authorization: Bearer $SOFIA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"establishmentId":"string","url":"https://cdn.example.com/tarte-tatin.jpg"}'

認可

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

ヘッダー

Idempotency-Keystring
同じボディで再送すると、2 回目のインポートを行わず同じレスポンスを返します。対象はフォーム項目で、ファイルのバイト列は含みません。

ボディ

application/json, multipart/form-data

establishmentIdstring必須
メディアを受け取るメディアライブラリを持つ店舗
urlstring
JSON：メディアの https URL。Sofia が自分で取得します（ファイルなし）
filestring<binary>
multipart/form-data：ファイル（画像または動画）。url とは併用できません

レスポンス

201application/json

ライブラリに追加されたメディア。

idstring必須
メディアの ID。投稿の media[].id に渡します
typestring必須
メディアの種類
使用できる値： imagevideo
urlstring必須
署名付きの URL。現在の有効期間内のみ有効です

400

ボディの形式が正しくありません。

401

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

402

subscription_required。

403

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

404

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

413

payload_too_large：アプリのサイズ上限を超えています。

422

media_import_refused（理由付き）：private_address、too_large、unsupported_media、unreachable、timeout、invalid_url、redirect_limit、removed_from_library。ファイルの場合は media_upload_refused。

4XXapplication/json

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

メディアを取り込む

curl --request POST \
  --url 'https://api.sofia-post.com/api/v1/media' \
  --header "Authorization: Bearer $SOFIA_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "establishmentId": "string",
  "url": "https://cdn.example.com/tarte-tatin.jpg"
}'

{
  "id": "string",
  "type": "image",
  "url": "string"
}