Getting Started with Distributor API
Introduction
The WithSecure™ Distributor API is designed to fulfill the following use cases:
- Fetch Order: This functionality allowed distributors to retrieve reseller orders placed in WithSecure™ Partner Portal.
- Order Confirmation: This functionality allowed distributors to confirm reseller orders placed in WithSecure™ Partner Portal.
To gain access to the Distributor API, kindly reach out to the WithSecure™ Support team or your dedicated WithSecure™ account manager.
Terminology
- Distributor - used to refer to a partner, for example, in ‘distributor_account_id’
- Reseller - used interchangeably with ‘reseller’
- Licensees - used interchangeably with ‘companies’ and ’end-customers’
- Users - used to refer to administrators (admin users)
Using the Distributor API
The Distributor API is built to support all essential business operations related to managing and confirming orders on WithSecure™ through the API. It eliminates the need for partners to implement custom logic in their systems for order management.
Business Features
| Business features | Endpoint to use | Notes |
|---|---|---|
| Retrieve pending orders | Fetch Order | Retrieves reseller orders submitted via the WithSecure™ Partner Portal. |
| Confirm pending orders | Order Confirmation | Confirms reseller orders placed through the WithSecure™ Partner Portal. |
Authentication and authorization
You must request access to the Distributor API from WithSecure™. We will provide you with separate system credentials together with business partner identifiers.
A partner system that calls the Distributor API needs to provide the given HTTPS credentials using a basic authentication scheme (RFC 7617) and initiating the HTTPS calls from allowed IP addresses. HTTPS credentials must match the allowed partner ID that defines the legal companies involved in the business transactions.
- distributor_account_id - identifies the partner’s legal company that uses the Distributor API
The WithSecure™ legal company that placed the order is linked to the partner ID and is managed within WithSecure™.
WithSecure™ provides the needed identifiers when the test and production environments have been created for you.
Technical environments
WithSecure™ provides two sets of system credentials: one for testing purposes and the other for production environments. This ensures that testing data remains separate from production data.