Dealer API

Appearance

Developer Guides ​

Welcome to the Developer Guides section for Axel Springer's Partner Activation API. This comprehensive collection of guides is crafted to support you through every phase of integrating and utilizing our API. From setting up your application and managing user pairings to handling purchases, cancellations, and navigating through potential errors, our guides are your roadmap to a successful integration.

Prerequisites for Integration ​

Before you begin, ensure you have the following:

  • The chosen integration flow: Agreed upon with our team, we choose which flow is best for your use case. Either the API-based Flow or the Single-use link Flow.
  • Partner ID (partnerId): Provided by our team, this ID is essential for identifying your organization within our systems.
  • Client ID and Client Secret: Keys for authenticating your application with our APIs, provided securely by our team.
  • Redirect URL: Required for user pairings; you must provide a URL to which users are redirected after activation.
  • Product IDs (productId): Required for creating a purchase, these IDs are used to identify the products your users can purchase and you need to provide them to us so that we can map them to our products in our system.

With these prerequisites in place, you're ready to dive into our detailed guides:

General Guides ​

Authentication Guide ​

Authentication Guide: Your starting point for integrating with the Partner Activation API. This guide covers setting up your application, securing your credentials, and making your first API calls securely using authentication tokens.

Error Handling Guide ​

Error Handling Guide: Equip yourself to manage and resolve potential errors gracefully. This guide explains the HTTP status codes and custom error codes our API may return, alongside suggested actions for resolution.

Testing Guide ​

Testing Guide: Before going live, ensure your integration works flawlessly. This guide outlines how to set up your testing environment, use test users and products, and conduct various test scenarios to simulate real-world operations without impacting live systems.

These guides are designed to provide you with all the information needed for a smooth and effective integration. Clear instructions, examples, and best practices are included to assist you through each step of the process. If you encounter any challenges or have questions along the way, our support team is here to help.

Deletion Guide ​

User Data Deletion Compliance: This guide is designed to help partners comply with the legal requirements of deleting user data from their systems when a user is deleted from our system. It provides detailed procedures on how to identify deletions through our API and ensure that all associated data is also removed from partner systems in accordance with privacy regulations.

API-based Flow Guides ​

This flow is designed for partners who will rely on the API to create and cancel the purchases to be able to manage them in their own systems with backend to backend communication.

User Pairing Guide ​

User Pairing Guide: Learn how to initiate the user pairing process. This guide outlines the unique browser-based user pairing, starting from the user pairing link. It walks through the steps of redirecting users through our login or registration process and then redirecting them to your specified URL with the CSU-ID as a query parameter. This CSU-ID is crucial for identifying the user on our side and should be mapped to their user ID in your system.

Purchase Guide ​

Purchase Guide: Detailed instructions on initiating and managing product purchases. This guide includes comprehensive examples of request payloads and the expected responses to help you understand how to interact with our purchasing endpoints.

Cancellation Guide ​

Cancellation Guide: Everything you need to know about managing purchase cancellations, including the steps to cancel a purchase and the associated API responses, ensuring your system handles cancellations effectively.

Onboarding Guide ​

Onboarding Guide This guide covers the necessary steps for leading the new subscriber into our onboarding processes, ensuring a smooth transition for new users.

Single-use Activation Link Flow Guides ​

This flow is designed for partners who will rely on the single-use activation link to activate the user and create the purchase, cancellation still can be only offered via the API endpoint, but the user-pairing and the creation of the purchase will be both done by the single-use link, the user will do both action in one step by clicking on the link and following the browser based process.

Single-use Activation Link Guide: This guide outlines the steps and requirements for using the Generate activation link endpoint effectively.

Support ​

For additional guidance or support, contact our Support Team.

Happy coding!