기술 자료

Webshop Client API

Webshop Client API

Webshop Config Service - Client API

Player-facing endpoints for store configuration and product catalog.
Download OpenAPI specification:

List eligible payment providers for the calling player

Returns the list of payment providers the calling player is eligible for, based on their Live Releases variant tags and the project's tag-to-provider routing configuration. Providers are listed in priority order, highest first; clients should use the first entry by default. An empty list means no provider is eligible for this player; clients should handle this as a normal "external payment unavailable" state.

Path parameters for "{title}"

projectId

string
필수
Genesis ID of the project

environmentId

string
필수
Genesis ID of the environment

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://webshop.services.api.unity.com/v1/projects/{projectId}/environments/{environmentId}/webshop/payment-providers"

Response example

{ "providers": [ "string" ]}
Return the webshop's storefront URL (published shop or draft preview) and whether it is live, for game/SDK link construction. A primary environment resolves anonymously to its live published URL, or 404 when not yet published, and never exposes a draft. A non-primary environment resolves to a short-lived draft preview URL that requires the player's Bearer token; without one it returns 404.

Path parameters for "{title}"

projectId

string
필수
Genesis ID of the project

environmentId

string
필수
Genesis ID of the environment

Query parameters for "{title}"

catalogListingId

string
Catalog listing id (the Live Content file path) to deep-link to that listing's product detail page. Declared here so generated SDKs expose it.

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://webshop.services.api.unity.com/v1/projects/{projectId}/environments/{environmentId}/storefront-link"

Response example

{ "projectId": "string", "environmentId": "string", "live": true, "storefrontUrl": "https://example.com", "productDetailUrl": "https://example.com"}

Create a shareable webshop link

Returns a short, shareable URL that opens this webshop with the supplied parameters applied. A published primary environment resolves to the live storefront; an unpublished primary environment returns 404; a non-primary environment resolves to a short-lived, token-gated preview of its draft. The response's live flag is true only for the live published storefront. Requires the player's Bearer token minted for this project and environment. Supplying a catalogListingId deep-links to that listing's product detail page.

Path parameters for "{title}"

projectId

string
필수
Genesis ID of the project

environmentId

string
필수
Genesis ID of the environment

Request body for "{title}"

Media Type:
application/json

params

array[object]
필수
Allowlisted link parameters, each applied as a query parameter named for its type (catalogListingId deep-links to a product detail page). A parameter with an empty value is ignored.

type

string
필수
The parameter kind; determines the query key and per-type validation.

value

string
필수
The parameter value, URL-encoded onto the link. An empty value is treated as if the parameter were omitted.

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "params": [ { "type": "sessionToken", "value": "string" } ]}' \ "https://webshop.services.api.unity.com/v1/projects/{projectId}/environments/{environmentId}/webshop-link"

Response example

{ "url": "https://example.com", "live": true}