In most cases, you already have an ERP or CRM system keeping your customer and/or license/subscription data.
The data_exchange area of the API provides functions in order to be able to sync the relevant data.
CUSTOMERS
SLASCONE has its own customer database, which means that not only you can import customers from your ERP/CRM, but you can always add/edit customers through the UI.
The field customer_number (string) constitutes the ID needed for all customer related sync functions. The customer_number is unique, you cannot have two customers with the same customer_number.
CREATE A CUSTOMER
POST /isv/{isv_id}/data_exchange/customers
Creates a new customer on the customer_number field, which is the customer’s ID in your source system.
UPDATE A CUSTOMER
PATCH /isv/{isv_id}/data_exchange/customers
Updates an existing customer. Please note that this is a REST-compliant PATCH method. This means, that missing properties are not being altered, e.g., if customer_type is missing from the request body, then the customer retains its actual customer_type.
More about differential updates can be found here.
LICENSES
In most cases, licenses are created using the SLASCONE UI. Nevertheless, you might want to sync licenses from a legacy system or a subscription management system or integrate this process in your back-office operations.
The field legacy_license_key (string) constitutes the ID needed for all customer related sync functions. The legacy_license_key is unique for a specific product, you cannot have two licenses of the same product with the same legacy_license_key.
CREATE A LICENSE BY EDITION
POST /isv/{isv_id}/data_exchange/licenses/by_template
This function allows you to create a license based on an edition (template_name). Make sure you have properly set up your edition before using this functionality.
Features, limitations and variables of the license can not be explicitly set using this function, since they are inherited from the edition.
UPDATE A LICENSE BY EDITION
PATCH /isv/{isv_id}/data_exchange/licenses/by_template
Updates a license. Please note that this is a REST-compliant PATCH method. This means, that missing properties are not being altered, e.g., if expiration_date is missing from the request body, then the license retains its actual expiration_date.
Features, limitations and variables of the license can not be explicitly changed using this function.
CREATE A LICENSE BY DETAILS
POST /isv/{isv_id}/data_exchange/licenses
This create function allows you to control all parameters of the license including features, limitations and variables.
UPDATE A LICENSE BY DETAILS
PATCH /isv/{isv_id}/data_exchange/licenses
This update function allows you to change all parameters of the license including features, limitations and variables.
CSV IMPORT
in addition to the API, you can import customers and licenses using a csv file. You can add or update customers based on the customer_number.
You can add licenses based on a specific edition. This functionality is identical to the one described previously.
Comments
0 comments
Please sign in to leave a comment.