メディア

メディアを取り込む

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

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

メディアを取り込む

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

認可

Authorizationstring必須

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

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

ヘッダー

Idempotency-Keystring

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

ボディ

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

メディアを取り込む

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"}'

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

メディアを取り込む

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"
}

URL からインポートする

establishmentId と公開の https の url を JSON で送ります。Sofia 自身がファイルをダウンロードして検証し、メディアライブラリに保存します。

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

ファイルをアップロードする

または、ファイルそのものを multipart/form-data で、file フィールドに入れて送ります。

curl -X POST https://api.sofia-post.com/api/v1/media \
  -H "Authorization: Bearer $SOFIA_API_KEY" \
  -F establishmentId=$ESTABLISHMENT_ID \
  -F file=@tatin.jpg

{
  "id": "393d5aa4-16f1-430f-b1d8-1fb1473076ef",
  "type": "image",
  "url": "https://…/393d5aa4-16f1-430f-b1d8-1fb1473076ef.jpg?X-Amz-…"
}

対応している内容

画像と動画、200 MB まで。
URL は公開の https である必要があります。プライベートアドレス、4 回以上のリダイレクト、30 秒を超えるダウンロードは拒否されます。
返される url は署名つきで、期限が切れます。id を保管しておき、新しい URL が必要な時は GET /v1/media/{id} でメディアを読み取り直してください。

拒否されたファイルには 422 media_import_refused または media_upload_refused が返り、理由は details に、対処方法は message に示されます。

認可

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

ヘッダー

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

ボディ

application/json, multipart/form-data

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

レスポンス

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

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

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