Dealer API

Appearance

Activation Link Generation Guide ​

Introduction ​

The Generate activation link endpoint is an integral part of our partner integration, enabling you to generate unique activation links for your users. These links facilitate a seamless and secure process for user activation and service access. This guide outlines the steps and requirements for using this endpoint effectively.

Prerequisites ​

Before you start generating activation links, ensure you have the following:

  • Authentication: Secure your API calls with a valid authentication token. Refer to our Authentication Guide for details on acquiring and using this token.
  • Partner ID: Your unique partner identifier provided during the integration setup.
  • Product and Purchase Reference: You must have the productId and purchaseRef ready to include in your request.

API Specification ​

Familiarize yourself with the activation-link endpoint's specifications, including request format and expected responses. Key aspects include:

  • Endpoint Details: URL, required headers, and HTTP method for the endpoint.
  • Request Schema: Structure and required fields, such as productId and purchaseRef.
  • Response Schema: Format and content of the expected response, including the activation link.

For comprehensive details, including schemas, visit our API Specifications.

Implementation Steps ​

To generate activation links for your users, follow these steps:

  1. Authenticate your API requests as outlined in our Authentication Guide.
  2. Ensure you have the productId and purchaseRef for the request.
  3. Construct and execute the API call to the activation-link endpoint using the specified format.
  4. Handle the response by extracting and securely distributing the activation link to your end-users.

Step 2: User Authentication and Activation ​

  1. The user clicks on the link.
  2. The link is validated, and then the user is taken to the authentication process.
  • If the user is not known to the system, they are taken to the registration. After a successful registration, a purchase is created, and the user can get access to the purchased product.
  • If the user is already known to the system, they can log in. After a successful authentication, the purchase is created, and then the user get access to the purchased product.

Testing and Validation ​

It is crucial to test the integration thoroughly:

  • Ensure the API call is constructed correctly and includes all required parameters.
  • Verify that the activation link is generated and returned in the response.
  • Test the end-to-end workflow, from link generation to user activation.

Support ​

If you encounter any issues or have questions, please consult our Developer Guides or reach out to our Support Team for assistance.