storefrontCrawlerSignatureGenerate

mutation

Requires write_themes access scope.

Generates signatures to authenticate storefront crawlers with configurable time-to-live.

Arguments

Anchor to domainHostdomainHost •String! required: Name of the domain for the signature.
Anchor to namename •String! required: Name of the storefront crawler signature.
Anchor to timeToLivetimeToLive •Int! required: Time to live for the signature in seconds.

Was this section helpful?

Anchor to domainHostdomainHost •String: Name of the domain for the signature.
Anchor to expiresAtexpiresAt •DateTime: Expiry date time for the signature.
Anchor to idid •ID: The ID of the generated storefront crawler signature.
Anchor to namename •String: Name of the storefront crawler signature.
Anchor to signaturesignature •String: The generated storefront crawler signature header.
Anchor to signatureAgentsignatureAgent •String: The generated signature-agent header.
Anchor to signatureInputsignatureInput •String: The generated signature-input header.
Anchor to userErrorsuserErrors •[StorefrontCrawlerSignatureGenerateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

mutation storefrontCrawlerSignatureGenerate($domainHost: String!, $name: String!, $timeToLive: Int!) {

storefrontCrawlerSignatureGenerate(domainHost: $domainHost, name: $name, timeToLive: $timeToLive) {

domainHost

expiresAt

name

signature

signatureAgent

signatureInput

userErrors {

field

message

}

{

"domainHost": "<your-domainHost>",

"name": "<your-name>",

"timeToLive": 1

}