Shares

By leveraging the shares endpoint, developers can generate shareable links that encapsulate the selected content, making it accessible to recipients while maintaining control over access permissions and visibility settings. It supports key features such as defining ownership, applying themes for branding, and tracking activity, enhancing both usability and oversight.

This endpoint is also integral to enabling smooth sharing workflows for users of the Content Picker, ensuring that selected content can be shared efficiently and effectively.

Prequisites

• Showpad Ultimate package
• Showpad admin account

Base Endpoint

The base endpoint for for creating a Share is:

https://{{subdomain}}.api.showpad.com/v4

Every API v4 request needs to be prefixed with the base endpoint.

CORS

Showpad adopts a strict approach for cross-origin requests. Only requests coming from your valid Showpad domain are allowed.

Shares Domain Language

To start working with Shares via API, it's important to understand the required terminology in order to work effectively.

	Description
anonymousUrl	A public link that allows anonymous (untracked) access to the Share. Ideal for broad sharing without recipient tracking. This is returned in the response.
assets	A list of assets (files, folders, or other content) to include in the Share. Each asset is identified by its unique id (e.g.,"e02519c27d539680c61e4fc44c596947").
createdAt	The timestamp indicating when the Share was created, formatted in ISO 8601 date and time format (e.g., YYYY-MM-DDTHH:MM:SS.sssZ). This is returned in the response.
dynamicUrl	A dynamic link that includes additional URL parameters to further enhance tracking when the link is visited by a buyer. This is returned in the response. Example ?recipient=xxx&platform=yyyy
expiresAt	The date and time when the Share link will expire, formatted in ISO 8601 (YYYY-MM-DDTHH:MM:SS.sssZ). After this date, the link will no longer be accessible.
isExternalDownloadAllowed	A boolean flag that indicates whether external users are permitted to download the shared content. Possible values: true (allowed) false (not allowed)
origin	Indicates the orginal source of the Share creation. Useful for tracking or analytics purposes.
theme	An object related to the visual or structural theme of this entity. It includes: id - A unique identifier for the theme applied to the Share.
title	The name or label assigned to the Share.
untrackedUrl	Another variation of the untracked link for access without tracking recipient behavior. This is returned in the response.

Create Share

You can create a Share resource for the selections in the Content Picker with the following request:

Method	Endpoint	Description
post	/shares	Creates a shareable resource, specifically for the Content Picker.

Example

The following example creates a new tracked Share link for a specific asset selected from the Showpad Content Picker. It sets the following configurations:

• Enables external users to download content and invite others.
• Applies a specific theme to the share.
• Provides a public-facing link (publicUri) for accessing the share.

POST https://{{subdomain}}.api.showpad.com/v4/shares

Payload: {
  "title": "Customer X share",
  "assets": [
    {
      "id": "e02519c27d539680c61e4fc44c596947"
    }
  ],
  "origin": "Integration",
  "isDownloadAllowed": true,
  "expiresAt": "2021-08-24T14:15:22.000Z",
  "theme": {
    "id": "9c5f3aa0784df25db1db821354e337e9"
  }
}

Response

If successful, this request will:

• Return a response containing details of the newly created share, such as its ID, access links, and other metadata.
• Enable users to share their selected content with the specified configurations.

 201 Share created

{
    "id": "f6297eda5146c386009e8bdfab99207d",
    "title": "Customer X share",
    "assets": [
        {
            "id": "e02519c27d539680c61e4fc44c596947"
        }
    ],
    "origin": "Integration",
    "isDownloadAllowed": true,
    "expiresAt": "2021-08-24T14:15:22.000Z",
    "theme": {
        "id": "51be10f001cd0303a4e308a22e051ecb5385615a564eeef116fec329acb33276"
    },
    "anonymousUrl": "https://{{subdomain}}.showpad.com/share/xncLlh9gYDjXPao4XOVlq",
    "untrackedUrl": "https://{{subdomain}}.showpad.com/share/1JmIS8oGyVEGUM4Cb3ETO",
    "dynamicUrl": "https://{{subdomain}}.showpad.com/catalog/link/xncLlh9gYDjXPao4XOVlq",
    "createdAt": "2024-11-21T15:43:25.000Z"
}