Skip to content

Area: Developers

GET

Single sign-on link into the Releva admin

Path
/users/partnerSignin/{token}/{payload}
Auth
None · a public or signed link
GET
/users/partnerSignin/{token}/{payload}
curl --request GET \
--url https://releva.ai/api/admin/users/partnerSignin/YOUR_PARTNER_TOKEN/YOUR_SIGNED_PAYLOAD

Open this URL in the merchant’s browser. Releva creates the user if needed (and sends a welcome email with a confirmation link to a new user), gives the user access to the shop’s account, signs the browser in and redirects to the shop’s admin: the plan confirmation page when subscriptionsToConfirm is set, the activation wizard for a Shopify shop that is not live yet, otherwise Analytics. Generate links on demand with a short expiry; do not cache them.

token
required
string format: uuid

Your partner token.

Example

YOUR_PARTNER_TOKEN
payload
required
string

JWT signed with your private key; claims as in PartnerSignInClaims.

Example

YOUR_SIGNED_PAYLOAD

Signed in; redirect to /admin/#/accounts/{accountId}/domains/{domainId}/analytics (or activate, or subscriptionsConfirm?subscriptionsToConfirm=...).

Unknown partner token or shop.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Examples

{
"message": "Partner identification is invalid!"
}

The payload could not be verified (missing, not a JWT, signed with another key, or expired), or another unexpected error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "An internal error occurred."
}