Check out the new features, minor fixes, and updates we've made to our platform and APIsChangelog
Home >

Single Sign-On (SSO)

Single sign-on can be used to pass customer information from your system into the cleverbridge checkout process. cleverbridge then maps this data to the corresponding checkout data fields and optimizes the customer experience.

The following describes how to pass information to the cleverbridge platform using single sign-on:

Note

There are two types of URLs that can be used to integrate single sign-on: session URLs (SURLs) and dynamic protected URLs (Dynamic UURLs). The following describes how to combine single sign-on with session URLs. If you are interested in integrating single sign-on with dynamic protected URLs, contact Client Experience.

  1. Create a URL that opens a checkout page for your product.

    Example

    https://www.cleverbridge.com/864/?scope=checkout&cart=97771

  2. Add the internalcustomer parameter to the link and add your unique identifier (UUID) as its value. The UUID should come from the Auth0 provider or your internal customer database. For more information, see Customer Data.

    Example

    https://www.cleverbridge.com/864/?scope=checkout&cart=97771&internalcustomer=de10405873838

  3. If needed, add parameters to the URL that correspond to the information you want to pre-populate on the checkout page. For a full list of available parameters, see List of Checkout Process Parameters.

    Example

    https://www.cleverbridge.com/864/?scope=checkout&cart=97771&internalcustomer=de10405873838

    &firstname=Han&lastname=Solo&email=han.solo%40cleverbridge.com&street1=Gereonstr.%2043

    &postalcode=50670&city=Cologne&country=Germany&language=en

  4. Transform the link into a session URL using the API. This protects the link and prevents someone from changing the UUID value in the internalcustomer parameter. For more information, see Generate User Session URL.

    Example

    {
        "Url": "https://www.cleverbridge.com/864/surl-7YOyMto99c",
        "ResultMessage": "OK"
    }
  5. Redirect the customer to the generated Url.

    Note

    Session URLs are limited to one user and can only be used once, regardless of whether or not the user completes the purchase. If they are not used, they auto-expire after 72 hours. For more information, see Create a Session URL (SURL).

  6. After the customer completes the purchase, you can retrieve data from the cleverbridge system using notifications (webhooks). For more information, see Notification Guide.