メディアメディアを一覧表示する

メディア

メディアを一覧表示する

店舗のメディアライブラリを新しい順にページ単位で返し、現在の有効期間内の署名付き URL を付けます。テストでもライブでも使えます。

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

メディアを一覧表示する

店舗のメディアライブラリを新しい順にページ単位で返し、現在の有効期間内の署名付き URL を付けます。テストでもライブでも使えます。

認可

Authorizationstring必須

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

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

クエリパラメーター

establishmentIdstring必須

メディアライブラリを読み取る店舗。

cursorstring

前のページの nextCursor。

limitnumber

ページサイズ。1 から 100 まで(既定値は 20)。

店舗のメディアは、新しい順にページごとに返ります。ページネーションをご覧ください。

各メディアの url は署名つきで、期限が切れます。id を保管しておき、新しい URL が必要な時は `GET /v1/media/{id}` でメディアを読み取り直してください。

認可

  • Authorizationstringheader必須

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

クエリパラメーター

  • establishmentIdstring必須

    メディアライブラリを読み取る店舗。

  • cursorstring

    前のページの nextCursor。

  • limitnumber

    ページサイズ。1 から 100 まで(既定値は 20)。

レスポンス

メディアの 1 ページ。続きがある場合は nextCursor を含みます。

  • dataobject[]必須

    このページのメディア

    子属性を表示
    • idstring必須

      メディアの ID。投稿の media[].id に渡します

    • typestring必須

      メディアの種類

      使用できる値: imagevideo

    • urlstring必須

      署名付きの URL。現在の有効期間内のみ有効です

    • fileNamestring必須

      ファイル名

    • contentTypestring必須

      ファイルの MIME タイプ

    • sizenumber必須

      サイズ(バイト)

    • createdAtstring<date-time>必須

      メディアが追加された日時

    • thumbnailUrlstring

      署名付きサムネイル(動画はポスター、画像は正方形)

  • nextCursorstring

    次のページには ?cursor= として渡します。最後のページでは含まれません

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