Bring Nalpeiron Zentitle2 into
the flow of work.
A little less busywork with Nalpeiron Zentitle2.
Attribute3 capabilities+
- Create global attribute
Create a global attribute that will be included in all entitlements. Default value can be overridden in product or edition level.
- Get global attribute
This method returns selected global attribute
- Get global attributes list
This method returns list of all attributes
Customer18 capabilities+
- Create customer
Creates new customer
- Create customer contact
This method creates a new customer contact. The contact must have a unique email address for the customer.
- Create customer note
Creates new customer note
- Disable customer
This method disables customer and it's entitlements
- Enable customer
This method re-enables customer and it's entitlements
- Get a customer contact list
This method returns a list of customer contacts
- Get contact credentials
Return the credentials for a contact. If contact does not have credentials, Authentication field will be null.
- Get customer
This method returns the selected customer
- Get customer contact
This method returns selected customer contact details
- Get customer end user portal url
This method returns customer End User Portal URL
- Get customer list
This method returns list of customers
- Get customer note
This method returns customer note
- Get customer note list
This method returns list of customer notes
- Get customer zentitle statistic
Return zentitle statistic for a given customer
- Request password action
This method allows to request setup password or reset password for selected contact. If the contact does not have credentials set up, the action will return an error. If the action is "setup", the contact will receive an email with a link t...
- Search contacts
This method search for customer contacts by email and returns paginated list of matching contacts
- Update contact credentials
Creates or updates credentials for a contact. Two types of authentication are supported: password and OpenID. When using OpenID authentication, the unique claim value is required. When using password, email will be sent to the contact's em...
- Update customer contact
This method updates the selected customer contact details. At least one property must be provided.
Entitlement32 capabilities+
- Activate entitlement
This method change state of entitlement that seats can be activated. Depending of offering configuration entitlement can be activated during entitlement creation.
- Add activation codes
This method will add activation codes to the entitlement group
- Assign contact to entitlement group
This method assigns a contact (with ABL credentials) to the entitlement group. If contact is already part of the entitlement group, the request will be ignored and complete successfully. Adding a contact which does not have ABL credentials ...
- Change entitlement offering
This method allows the change of an entitlement offering. This method can only modify the entitlement to a different offering if the new offering belongs to the same product. If the new offering has a lower seat count than the seats current...
- Checkout activation feature
This method checkouts some amount feature. Feature can be used permanently (usage count) or can be returned (element pool) using return feature method.
- Create activation
Activate entitlement for provided seat ID and create activation that can be used feature management This method will work only when entitlement was created before create activation is called
- Create an entitlement group
Create an entitlement group providing a list of product SKUs. For each SKU provided an entitlement will be created within the entitlement group. All other parameters are optional. Activation code is also optional, and if not provided, it wi...
- Create entitlement note
Creates new entitlement note
- Disable entitlement
This method disables entitlement. Disabled entitlement cannot be activated.
- Enable entitlement
This method re-enables entitlement. Enabled entitlement can be used normally.
- Extend entitlement group
Extend an existing entitlement group by adding new entitlements based on the provided SKUs. This will add additional entitlements to the existing entitlement group.
- Find entitlement group by activation code
This endpoint looks up an entitlement group using an activation code and product identifier
- Generate activation codes
This method will generate new codes and add them to the entitlement group
- Get activation state
This method returns activation details including information about attributes and available features
- Get an entitlement group
This method returns entitlement group details. The amount of data returned can be adjusted by using query expand parameter configuration.
- Get entitlement
This method returns entitlement details
- Get entitlement group authorized contacts
This method returns list of contacts (with ABL credentials) authorized for the entitlement group
- Get entitlement group list
This method returns entitlement group list. Amount of data returned can be adjusted by using query expand parameter configuration.
- Get entitlement list
This method returns list of entitlements that can be filtered by following query parameters
- Get entitlement note
This method returns entitlement note
- Get entitlement note list
This method returns list of entitlement notes
- List of entitlement activations
This method returns list of entitlement activation that can be filtered by following query parameters
- Log of activations activity
This method returns log of activations activity on the entitlement
- Refresh activation
Refresh lease time of provided seat activation When activation lease expiry already equals entitlement expiry, next and any subsequent refreshes will fail since the activation cannot be extended beyond the entitlement expiry
- Remove activation codes
This method will remove activation codes from the entitlement group
- Renew entitlement
Renews a subscription entitlement. This method is specially designed for renewal of previously activated subscription entitlements. The new expiry date is determined using following rules: * If the expiration date has passed but the grace p...
- Reset entitlement overrides
This method allows to reset entitlement overrides to match current product configuration. Each field can be reset individually by setting corresponding field to true. This method can also to restore current configuration for features and at...
- Reset usage count of a feature
Only usage count features can be reset
- Return activation feature
This method returns amount of feature. Only element pool features are allowed to be returned.
- Trigger provision event
This method triggers provision webhook event for the entitlement
- Update entitlement
Allows to change settings of selected entitlement, including attributes and features. Only provided features and attributes will be processed. If the caller has no intentions to update features or attributes those field can be sent as null ...
- Update entitlement group
Entitlement group update
Feature3 capabilities+
- Create global feature
Create a global feature that will be included in all entitlements. Default value can be overridden in product or edition level.
- Get global feature
This method returns selected global feature
- Get global features list
This method returns list of all global features
Offering4 capabilities+
- Create offering
Creates new offering
- Get offering
This method returns offering details
- Get offering list
This method returns list of offering that can be filtered by the following query parameters
- Update offering
This method allows changing selected offering attributes without providing the full payload
Plan3 capabilities+
- Create plan
Creates new plan
- Get plan
This method returns plan details
- Get plan list
This method returns list of plans that can be filtered by following query parameters
Product19 capabilities+
- Create edition
Creates new product edition
- Create product
Creates a new product with default settings
- Create product attribute
Create new product attribute. Value defined for this attribute can be overridden in each edition if required.
- Create product feature
Create new product feature. Value defined for this feature can be overridden in each edition if required.
- Get a product list
This method returns a list of products that can be filtered by following query parameters
- Get edition
This method returns product edition details
- Get edition attribute
This method returns selected attribute with value defined in edition level (in case of override). If no value is defined in edition level, value defined in higher level is returned.
- Get edition attributes list
This method returns list of all attributes for selected edition
- Get edition feature
This method returns selected feature with value defined in edition level (in case of override). If no value is defined in edition level, value defined in higher level is returned.
- Get edition feature list
This method returns list of all features for selected edition
- Get edition list
This method returns list of editions that can be filtered by following query parameters
- Get product
This method returns product details
- Get product attribute
This method returns selected attribute. In case of global attribute, if overridden value exists on product level, it will be returned, otherwise global value will be returned.
- Get product attributes list
This method returns list of all attributes for selected product
- Get product feature
This method returns selected feature. In case of global feature, if overridden value exists on product level, it will be returned, otherwise global value will be returned.
- Get product features list
This method returns list of all features for selected product
- Update edition attribute
This method allows to change value of selected attribute for specific edition. This method can be used to override default value of global and products attributes.
- Update product
This method allows updating selected product properties. At least one property has to be provided, otherwise the request will be rejected.
- Update product attribute value
This method can be used to change value of selected product attribute. This method can be used to override default value of global attributes for each product separately.
Frequently asked
questions.
What could an Ambacti integration do with Nalpeiron Zentitle2?
The documented operations include Attribute: Create global attribute; Attribute: Get global attribute; Attribute: Get global attributes list; Customer: Create customer.
Could I keep a workflow read-only?
For a read-only workflow, limit account permissions to reading data and exclude actions that create, update, or delete records.
Will every action run automatically?
Choose which steps could run on their own and which should pause for review. Changes should follow the permissions and approval rules you set.
Do I need to review actions in Nalpeiron Zentitle2?
Decide which work could run on its own and which steps need your review.