Generate authenticated URL

Generates an authenticated URL for a specific target (home or loyalty) for a user. This endpoint is used for server-side URL generation.

POST
/sdk/server/generate_url
x-stash-hmac-signature<token>

Versioned HMAC-SHA256 signature authenticating server-to-server SDK requests (your backend calling Stash), as opposed to client-side SDK operations. Recommended over the deprecated X-Stash-Api-Key for the best security. Header format: v1;{appId};{unixMillisTimestamp};{base64Signature} (semicolon-delimited). {base64Signature} is the base64-encoded HMAC-SHA256 of the string {unixMillisTimestamp}.{requestBody} using your app ingress secret (the ingress secret is shown base64-encoded in Studio; base64-decode it to the raw bytes used as the HMAC key), where {requestBody} is the compact canonical request JSON for POST requests and empty for GET requests. The timestamp must be within 5 minutes of Stash server time. Your appId is your immutable app identifier, shown in Stash Studio under Project Settings > App details; your ingress secret is under Project Settings > API Secrets.

In: header

user?pie.sdk.urls.User

User information for URL generation

target?pie.sdk.urls.GenerateAuthenticatedUrlRequest.Target

Target destination for the generated URL

Default"DEFAULT"
Value in"DEFAULT" | "HOME" | "LOYALTY" | "ROOT" | "STORE" | "DAILY_STREAK"

Response Body

curl -X POST "https://test-api.stash.gg/sdk/server/generate_url" \  -H "Content-Type: application/json" \  -d '{}'
{
  "url": "string"
}
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string",
      "property1": null,
      "property2": null
    }
  ]
}

How is this guide?