Skip to content
Navigation

Mints a short-lived URL to an attachment's file, where the customer may reach it.

POST
https://api.sherpo.io/customer/v1/stores/{store}/attachments/url

Authorization

  • bearer
    optional
    HTTP
  • publishableKey
    optional
    API key in header

Path parameters

  • store
    string
    required

    A hostname of the store.

Request body JSON required

  • attachment
    string
    required
    maxLength: 512 · minLength: 1
  • renew
    optional
    boolean
  • intent
    optional
    download
    or
    view

    For a lesson's slides or a PDF a text shows: shown in the viewer as uploaded, or slides downloaded at their protection where the caller may; none serves them as bound.

  • track
    optional
    string

    One of the video's tracks, served inline to whoever may play the video.

    maxLength: 512 · minLength: 1
  • preview
    optional
    string

    A token a seller made for a product's or a page's page, which opens the files its read lists unpublished, gated as ever.

    maxLength: 128 · minLength: 1

Returns

200

Mints a short-lived URL to an attachment's file, where the customer may reach it.

JSON
  • url
    string
    required
  • expires_at
    required

    One of the following:

    • string
    • null
  • intent
    required

    What the URL is for: shown, saved or played; null for a link or public bytes, which open as they are.

    One of the following:

    • string
    • null
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close