Provision Family plans via API
API access to creating free family plans associated to a business account
Note: This API is for partners of Keeper and Enterprise customers deployed in the Keeper Security Government Cloud region.
Keeper offers enterprise customers APIs to provision Family plans. Keeper provides REST APIs that enable you to build custom applications and integration in provisioning Family plans.
Provision Family Plan API endpoint is for enterprise accounts & MSP partners to register Keeper Family licenses. This endpoint will create a 1 year license with the following Product/Add-ons:
- Keeper Family
- BreachWatch (Dark Web Monitoring)
- 10GB File Storage
In order to access this API, contact your support representative to request an API key, this will be shared in a Keeper record.
post
https://keepersecurity.com/bi_api/v1/services/partner
/create-license
For more information on the required parameters, visit:
For more information on the response codes, visit:
If you wish to explore the APIs in another tool like postman or the swagger editor, download the associated YAML definition of the APIs below
FamilyPlan.yaml
4KB
Code
For more information on exploring the API with swagger, visit:
If you need support or have additional questions on the usage of these APIs, please contact support or your sales representative.
Use the below sample so understand how you might implement this in your environment:
var request = require('request');
var CryptoJS = require('crypto-js');
var secret = 'PARTNER_SECRET';
var partner_name = 'PARTNER_NAME';
var email = 'EMAIL';
var hash = CryptoJS.SHA256(email + secret);
var transaction_id = 'TRANSACTION_ID';
var first_name = 'FIRST_NAME';
var last_name = 'LAST_NAME';
var options = {
'method': 'GET',
'url': 'https://keepersecurity.com/bi_api/v1/services/partner/create-license?transaction_id='+transaction_id+'&first_name='+first_name+'&last_name='+last_name+'&email='+email+'&hash='+hash+'&partner_name='+partner_name+'',
'headers': {
'Content-Type': 'application/json'
}
};
request(options, function (error, response) {
if (error) console.log("Error From the server: "+error);
console.log("response body: "+response.body);
console.log("response status: "+response.statusCode);
});
Last modified 17d ago