The purpose of Stripe integration with Nalpeiron is to automate processing of orders coming from Stripe, license code allocation and setting license properties in Nalpeiron.
Our backend integration application is called "FS Connector".
Defining Webhook URL
The integration is done via webhooks. To start, add new Webhook URL in Stripe and provide required parameters in the querystring:
apiUserName: your Nalpeiron API username
apiPassword: your Nalpeiron API password
apiCustomerId: your Nalpeiron Customer Id
Endpoint URL : https://fsconnector.nalpeiron.com/api/webhooks/stripe
Select “invoice.paid” event to be sent.
Example:
Product Metadata
The rest of the integration is done via product metadata, which can be specified for each Stripe product separately.
Possible attributes:
- productId - Nalpeiron product Id (required)
- profile - Nalpeiron profile for pulling License Codes (required)
- licenseCodeFormat - a code mask for defining the License Code format. Explained in a section below
- emailFromAddress - FROM email address for the confirmation email (set by default to noreply@nalpeiron.com)
- numberofSeats - Number of allowed activations for the given license code as per the order
- aaFields - set AA agility fields in Nalpeiron. Explained in a section below.
- features - enable/disable features. Explained in a section below.
- clientLeasePeriod - sets codes client lease period
- clientOfflineLeasePeriod - sets codes client offline lease period
- vmLeasePeriod - sets codes VM’s client lease period
- accountIdField - sets name of the AA field where the purchase order id will be stored, example: PurchaseID
- maintenence - if set to true then the subscription end date is entered into the maintenance end date for the License Code
- maintenanceAddon - if maintenance is not set (or is false), set it to the Id of a FastSpring add-on maintenance subscription product, example: maintenance-professional
License Code Format
If License Code Format is provided, FS Connector will generate and allocate a license code automatically. To enable this feature, licenseCodeFormat has to be set in product metadata. It’s a code mask for defining the LicenseCode format, example: ELV-***-*%*-*%*. Wild cards:
* - any uppercase letter char (no use of ‘O’)
% - any numeric char (no use of ‘0’)
The example stated above could generate such code: ELV-HEV-J3D-N7R
If licenseCodeFormat is not set, FS Connector will not allocate new code in the profile.
Maintenance handling
Maintenance can be enabled on a purchase by setting the maintenance field on a product directly or by adding a separate product to a purchase. In the second case, it’s required to set maintenanceAddon field to the ID if the maintenance product. If this product has been purchased with the main one, the maintenance end date will be set for the allocated Licence Code
AA agility fields
By setting “aaFields” custom variable it’s possible to specify AA agility variables set in Nalpeiron for the allocated license code. It should be set to a valid JSON object in a form: {fieldname1: value1, fieldname2: value2}, for example: {“description”: “stripe”}
Features
By setting “features” custom variable, it’s possible to enable or disable certain features on an allocated license code. It should be set to a valid JSON object in a form: {feature1:true, feature2: false}, for example {“BATCH”: true, “ADVSM”: false}