Note: These APIs only apply to distributors of MSP accounts. Most MSPs are able to manage companies via commander '' commands.
Capabilities of the APIs
The primary use cases enabled via the API are:
Create Trial Account
Convert To Paid Account
List all MSPs
Get Current Usage
Get Monthly Usage
Cancel Paid Account
Activate Expired Accounts
List MSP Products
Delete Pending/Conflict Accounts
In order to access the MSP specific APIs, contact your support representative to request an API key, this will be shared as a secret key in a Keeper record.
API definitions
Creating a JSON Web Token from your pre-shared secret
After access has been requested, Keeper will share a record with you that will include the necessary information to use the APIs. In order to use any of the above API methods, a JWT needs to be created. In the below example, the 'iat' and 'exp' are 5 minutes apart. The below code will generate the token needed in the web request:
The below script will correctly generate JWT and has the data needed for the 'create-trial-account' POST.
var jwt = require('jsonwebtoken');
var request = require('request');
var rightnowTimeStampInSeconds = Math.floor(Date.now() / 1000);
jwt.sign({
"iat": rightnowTimeStampInSeconds ,
"iss": "PARTNER_KEY",
"exp": rightnowTimeStampInSeconds + (60*5) //adding 5 mins
}, "PARTNER_SECRET", { algorithm: 'HS512' }, function(err, token) {
var options = {
'method': 'POST',
'url': '',
'headers': {
'vendor': 'PARTNER_NAME',
'Authorization': 'Bearer '+ token,
'Content-Type': 'application/json'
},
body: '{"name":"string","country":"US","zipCode":"98001","email":"test+werworir@keeperdemo.io","vendorInternalId":"89654we7r64ert65","state":"CA","city":"My city","street":"the street","phone":"19191919191"}'
};
request(options, function (error, response) {
if (error) console.log("Error From the server: "+error);
console.log("response body: "+response.body);
});
});
Other methods to generate the JWT
For encryption, use HS512 Algorithm
Use the below json as payload, note this token has a 5 minute expiration
use secret.key as secret key to encode the token
{
"iat": timestamp in unix ,
"iss": "consumer.key",
"exp": timestamp in unix
}
Additional API detail
MSP Account Statuses
Certain API endpoints will return the status of an MSP. The below explains what each status is:
Status
Definition
PENDING
When an account is created created via the /create-trial-account endpoint, an email is sent inviting the user to activate the account and begin thier trial.
TRIAL
A newly activated MSP automatically starts with a 14 day trial. At the end of the trial, if the /convert-to-paid endpoint is not called, the MSP will be deactivated and they can no longer login. Data will be deleted after 1 year. An expired trial can be re-activated within the data retenion period.
ACTIVE
An active, paid MSP account with an expiration date some time in the future.
REGION_CONFLICT
When an account is created via the /create-trial-account endpoint in US region instead of activating account from email link, user activated trial account from website in other region. Field “accountRegion” in response shows the registered account region.
PRODUCT_CONFLICT
When an account is created created via the /create-trial-account endpoint in US region instead of activating account from email link, user activated enterprise trial/consumer trial account from website. Field “productType” in response shows the Keeper product type
EXPIRED
if the /cancel-paid-account endpoint is called, the MSP provided will be immediately expired and billing will stop for this MSP.
Product ID to SKU mapping
Each Keeper line item has a human readable name that maps to ID's. These are provided in the usage API endpoints.
{"success":true,"usage":{"total":2387.74,"tax":0,"currency":"USD","mcItems":[{"companyId":"NDU5OTk","total":3,"companyName":"49ers","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3}]},{"companyId":"NDU5OTE","total":278.2,"companyName":"Bears","products":[{"unitPrice":4.8,"unit":"user","quantity":30,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":144},{"unitPrice":0.5,"unit":"user","quantity":30,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":15},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":1,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":25.2},{"unitPrice":1,"unit":"user","quantity":30,"productId":910,"productName":"KeeperChat","avgMonthlyCost":30}]},{"companyId":"NDU5OTM","total":2.25,"companyName":"Buccaneers","products":[{"unitPrice":2.25,"unit":"user","quantity":1,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":2.25}]},{"companyId":"NDU5OTg","total":4.2,"companyName":"Cardinals","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDU5ODc","total":3,"companyName":"Commanders","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3}]},{"companyId":"NDYwMDk","total":2.25,"companyName":"Company 1","products":[{"unitPrice":2.25,"unit":"user","quantity":1,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":2.25}]},{"companyId":"NDYwMTA","total":4.2,"companyName":"Company 2","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDU5ODU","total":2.25,"companyName":"Cowboys","products":[{"unitPrice":2.25,"unit":"user","quantity":1,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":2.25}]},{"companyId":"NDU5ODY","total":4.2,"companyName":"Eagles","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDU5OTU","total":3,"companyName":"Falcons","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3}]},{"companyId":"NDU5ODg","total":4.8,"companyName":"Giants","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8}]},{"companyId":"NDU5OTI","total":4.8,"companyName":"Lions","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8}]},{"companyId":"NDkzNDk","total":181.04,"companyName":"MC Test","products":[{"unitPrice":4.8,"unit":"user","quantity":0.89,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.27},{"unitPrice":89,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":89},{"unitPrice":0.5,"unit":"user","quantity":0.89,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.45},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":0.89,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":22.43},{"unitPrice":1,"unit":"user","quantity":0.89,"productId":910,"productName":"KeeperChat","avgMonthlyCost":0.89}]},{"companyId":"NDYwMDE","total":37.5,"companyName":"NFC Business","products":[{"unitPrice":2.25,"unit":"user","quantity":10,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":22.5},{"unitPrice":0.5,"unit":"user","quantity":10,"productId":920,"productName":"Advanced Reporting & Alerts","avgMonthlyCost":5},{"unitPrice":1,"unit":"user","quantity":10,"productId":930,"productName":"BreachWatch","avgMonthlyCost":10}]},{"companyId":"NDY5NTk","total":421.25,"companyName":"NFC Business - All Upgrades","products":[{"unitPrice":2.25,"unit":"user","quantity":1,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":2.25},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":920,"productName":"Advanced Reporting & Alerts","avgMonthlyCost":0.5},{"unitPrice":1,"unit":"user","quantity":1,"productId":930,"productName":"BreachWatch","avgMonthlyCost":1},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":10,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":252},{"unitPrice":1,"unit":"user","quantity":1,"productId":910,"productName":"KeeperChat","avgMonthlyCost":1}]},{"companyId":"NDYwMDI","total":4.2,"companyName":"NFC Business Plus","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDY5NjA","total":194.9,"companyName":"NFC Business Plus - All Upgrades","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":1,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":25.2},{"unitPrice":1,"unit":"user","quantity":1,"productId":910,"productName":"KeeperChat","avgMonthlyCost":1}]},{"companyId":"NDYwMDM","total":3,"companyName":"NFC Enterprise","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3}]},{"companyId":"NDY5NjI","total":195.2,"companyName":"NFC Enterprise - All Upgrades","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":920,"productName":"Advanced Reporting & Alerts","avgMonthlyCost":0.5},{"unitPrice":1,"unit":"user","quantity":1,"productId":930,"productName":"BreachWatch","avgMonthlyCost":1},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":1,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":25.2},{"unitPrice":1,"unit":"user","quantity":1,"productId":910,"productName":"KeeperChat","avgMonthlyCost":1}]},{"companyId":"NDYwMDQ","total":4.8,"companyName":"NFC Enterprise Plus","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8}]},{"companyId":"NDY5NjE","total":195.5,"companyName":"NFC Enterprise Plus - All Upgrades","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":1,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":25.2},{"unitPrice":1,"unit":"user","quantity":1,"productId":910,"productName":"KeeperChat","avgMonthlyCost":1}]},{"companyId":"NDU5ODk","total":239,"companyName":"Packers","products":[{"unitPrice":3,"unit":"user","quantity":30,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":90},{"unitPrice":25,"quantity":1,"productId":1011,"productName":"1TB Secure File Storage","avgMonthlyCost":25},{"unitPrice":0.5,"unit":"user","quantity":30,"productId":920,"productName":"Advanced Reporting & Alerts","avgMonthlyCost":15},{"unitPrice":1,"unit":"user","quantity":30,"productId":930,"productName":"BreachWatch","avgMonthlyCost":30},{"unitPrice":0.5,"unit":"user","quantity":30,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":15},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64}]},{"companyId":"NDU5OTY","total":4.8,"companyName":"Panthers","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8}]},{"companyId":"NDU5OTc","total":4.5,"companyName":"Rams","products":[{"unitPrice":2.25,"unit":"user","quantity":2,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":4.5}]},{"companyId":"NDU5OTQ","total":4.2,"companyName":"Saints","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDYwMDA","total":9.6,"companyName":"seahawks","products":[{"unitPrice":4.8,"unit":"user","quantity":2,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":9.6}]},{"companyId":"NDU5OTA","total":4.2,"companyName":"Vikings","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]}],"subTotal":2387.74,"mspItem":{"companyId":"NDU5Njg","total":567.9,"companyName":"QaMspNfl","products":[{"unitPrice":3.4,"unit":"user","quantity":31,"productId":720,"productName":"MSP Base License","avgMonthlyCost":105.4},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":31,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":15.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":10,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":252},{"unitPrice":1,"unit":"user","quantity":31,"productId":910,"productName":"KeeperChat","avgMonthlyCost":31}]}}}
The account creation API will automatically send an email to the created/invited account. Exmaple below.
If you need support or have additional questions on the usage of these APIs, please contact support or your sales representative.
You can use a look like to generate your JSON Web Token from the pre-shared secret.
If you wish to explore the APIs in another tool like postman or the , download the associated YAML definition of the APIs below
