vtexads-api-docs

8. SSO (Single Sign-On)

API for unified seller login. When calling this API, Newtail generates a redirect URL that allows the user to access the Newtail platform without needing to log in again.

• Endpoint: POST /sso/marketplace
• Request Body:

Field	Description	Type	Required?
sso_token	User identification token generated by the marketplace.	String	Yes
email	User’s (seller’s) email.	String	Yes
user_id	Unique user ID in the marketplace.	String	Yes
name	User’s name.	String	Yes
marketplace_name	Name of the marketplace.	String	Yes

• Request Example:

  {
    "sso_token": "sso-token-12345",
    "email": "seller@example.com",
    "user_id": "seller123",
    "name": "Seller Name",
    "marketplace_name": "My Marketplace"
  }
  

• Success Response: HTTP 200 OK with the redirect URL.

  {
    "redirect_url": "https://app.ads.vtex.com/sso/auth?token=GENERATED_TOKEN"
  }