アカウントマネジメントAPI
MSPやディストリビューターがアカウントを管理するためのAPI
これらのAPIはMSPアカウントのディストリビューターにのみ適用されます。ほとんどのMSPは、コマンダーの'msp'コマンドで会社を管理することができます。
APIの機能
APIで実現する主なユースケースは以下の通りです。
試用版アカウントの作成
有料アカウントに変更する
MSPをすべて表示する
現在の使用状況を取得する
月間の使用量を所得する
有料会員登録の取り消し
期限切れのアカウントをアクティブ化する
MSP製品の一覧表示
保留中/競合するアカウントの削除
MSP固有のAPIにアクセスするために、サポート担当者に連絡してAPIキーを要求してください。これはKeeperレコードでJWTトークンとして共有されます。
API定義
事前共有シークレットからJSON Web Tokenを作成する
アクセスが要求された後、KeeperはAPIを使用するために必要な情報を含むレコードをお客様と共有します。上記のAPIメソッドを使用するために、JWTを作成する必要があります。以下の例では、「iat」と「exp」は5分間隔になっています。以下のコードは、ウェブリクエストで必要なトークンを生成するものです。
System.out.println(LocalDateTime.now().toEpochSecond(ZoneOffset.UTC));
System.out.println(LocalDateTime.now().plusMinutes(5).toEpochSecond(ZoneOffset.UTC));
JWTスクリプトのサンプル例
以下のスクリプトは、JWTを正しく生成し、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);
});
});
その他のJWT生成方法
JWT.ioのようなサービスを利用すれば、事前共有シークレットからJSON Web Tokenを生成することができます。
暗号化には、HS512アルゴリズムを使用。
ペイロードとして以下のjsonを使用します。このトークンは5分間有効であることにご注意ください。
トークンをエンコードするための秘密キーとして
secret.key
を使用。
{
"iat": timestamp in unix ,
"iss": "consumer.key",
"exp": timestamp in unix
}
APIについての追加詳細
MSPのアカウント・ステータス
一部のAPIエンドポイントでは、MSPのステータスが返されます。以下では、それぞれのステータスが何であるかを説明します。
ステータス | 定義 |
---|---|
Pending (保留中) |
|
Trial (トライアル) | 新しくアクティベートされたMSPは、自動的に14日間のトライアルを開始します。試用期間終了後、 |
Active (アクティブ) | 今後有効期限がある、有効な有料MSPアカウント。 |
Region_Conflict (地域の競合) | 電子メールリンクからアカウントをアクティブ化するのではなく、米国地域の |
Product_Conflict (製品の競合) | 電子メールリンクからアカウントをアクティブ化するのではなく、米国地域の |
Expired (期限切れ) |
|
Product IDからSKUマッピング
各Keeperラインアイテムは、IDに対応する人間の読みやすい名前を持っています。これらは使用APIエンドポイントに提供されます。
productID | Line Item |
---|---|
720 | Keeper MSP |
10001 | Keeper Business |
10002 | Keeper Business Plus |
10010 | Keeper Enterprise |
10011 | Keeper Enterprise Plus |
967 | Keeper Connection Manager Add On |
968 | Keeper Secrets Manager Add On |
910 | KeeperChat Add On |
920 | Keeper ARAM Add On |
930 | Keeper BreachWatch Add On |
940 | Keeper Compliance Reporting Add On |
1011 | Keeper 1TB Storage Add On |
1012 | Keeper 10TB Storage Add On |
730 | Dedicated Service & Support |
API definition YAML file
postmanやswaggerエディタなどの他のツールでAPIを探索したい場合は、以下のAPIの関連YAML定義をダウンロードしてください。
現在の使用状況の出力例
{"success":true,"usage":{"mcItems":[{"companyId":"NDU5ODU","companyName":"Cowboys","products":[{"unit":"bundles","quantity":1,"productId":10001,"productName":"Keeper Business Bundle"}]},{"companyId":"NDU5ODY","companyName":"Eagles","products":[{"unit":"bundles","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle"}]},{"companyId":"NDU5ODc","companyName":"Commanders","products":[{"unit":"bundles","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle"}]},{"companyId":"NDU5ODg","companyName":"Giants","products":[{"unit":"bundles","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle"}]},{"companyId":"NDU5ODk","companyName":"Packers","products":[{"unit":"bundles","quantity":30,"productId":10010,"productName":"Keeper Enterprise Bundle"},{"unit":"GB","quantity":1000,"productId":1011,"productName":"1TB Secure File Storage"}]},{"companyId":"NDU5OTA","companyName":"Vikings","products":[{"unit":"bundles","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle"}]},{"companyId":"NDU5OTE","companyName":"Bears","products":[{"unit":"bundles","quantity":30,"productId":10011,"productName":"Keeper Enterprise Plus Bundle"}]},{"companyId":"NDU5OTI","companyName":"Lions","products":[{"unit":"bundles","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle"}]},{"companyId":"NDU5OTM","companyName":"Buccaneers","products":[{"unit":"bundles","quantity":1,"productId":10001,"productName":"Keeper Business Bundle"}]},{"companyId":"NDU5OTQ","companyName":"Saints","products":[{"unit":"bundles","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle"}]},{"companyId":"NDU5OTU","companyName":"Falcons","products":[{"unit":"bundles","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle"}]},{"companyId":"NDkzNDk","companyName":"MC Test","products":[{"unit":"bundles","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle"},{"unit":"GB","quantity":10000,"productId":1012,"productName":"10TB Secure File Storage"}]},{"companyId":"NDU5OTY","companyName":"Panthers","products":[{"unit":"bundles","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle"}]},{"companyId":"NDU5OTc","companyName":"Rams","products":[{"unit":"bundles","quantity":2,"productId":10001,"productName":"Keeper Business Bundle"}]},{"companyId":"NDU5OTg","companyName":"Cardinals","products":[{"unit":"bundles","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle"}]},{"companyId":"NDU5OTk","companyName":"49ers","products":[{"unit":"bundles","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle"}]},{"companyId":"NDYwMDA","companyName":"seahawks","products":[{"unit":"bundles","quantity":2,"productId":10011,"productName":"Keeper Enterprise Plus Bundle"}]},{"companyId":"NDYwMDE","companyName":"NFC Business","products":[{"unit":"bundles","quantity":10,"productId":10001,"productName":"Keeper Business Bundle"}]},{"companyId":"NDYwMDI","companyName":"NFC Business Plus","products":[{"unit":"bundles","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle"}]},{"companyId":"NDY5NTk","companyName":"NFC Business - All Upgrades","products":[{"unit":"bundles","quantity":1,"productId":10001,"productName":"Keeper Business Bundle"},{"unit":"GB","quantity":10000,"productId":1012,"productName":"10TB Secure File Storage"}]},{"companyId":"NDYwMDM","companyName":"NFC Enterprise","products":[{"unit":"bundles","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle"}]},{"companyId":"NDY5NjA","companyName":"NFC Business Plus - All Upgrades","products":[{"unit":"bundles","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle"},{"unit":"GB","quantity":10000,"productId":1012,"productName":"10TB Secure File Storage"}]},{"companyId":"NDYwMDQ","companyName":"NFC Enterprise Plus","products":[{"unit":"bundles","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle"}]},{"companyId":"NDY5NjE","companyName":"NFC Enterprise Plus - All Upgrades","products":[{"unit":"bundles","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle"},{"unit":"GB","quantity":10000,"productId":1012,"productName":"10TB Secure File Storage"}]},{"companyId":"NDY5NjI","companyName":"NFC Enterprise - All Upgrades","products":[{"unit":"bundles","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle"},{"unit":"GB","quantity":10000,"productId":1012,"productName":"10TB Secure File Storage"}]},{"companyId":"NDYwMDk","companyName":"Company 1","products":[{"unit":"bundles","quantity":1,"productId":10001,"productName":"Keeper Business Bundle"}]},{"companyId":"NDYwMTA","companyName":"Company 2","products":[{"unit":"bundles","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle"}]}],"mspItem":{"companyId":"NDU5Njg","companyName":"QaMspNfl","products":[{"unit":"licenses","quantity":31,"productId":720,"productName":"MSP Base License"},{"unit":"GB","quantity":10000,"productId":1012,"productName":"10TB Secure File Storage"},{"unit":"","quantity":1,"productId":730,"productName":"Dedicated Service & Support"},{"unit":"licenses","quantity":31,"productId":920,"productName":"Advanced Reporting & Alerts"},{"unit":"licenses","quantity":31,"productId":940,"productName":"Compliance Reporting"},{"unit":"licenses","quantity":31,"productId":930,"productName":"BreachWatch"},{"unit":"KCM users","quantity":10,"productId":967,"productName":"Keeper Connection Manager (KCM)"},{"unit":"licenses","quantity":31,"productId":910,"productName":"KeeperChat"}]}}}
月間使用量の出力例
{"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}]}}}
アカウント作成APIは、作成された/招待されたアカウントに自動的にメール (英語のみ) を送信します。以下はサンプルです。
これらのAPIの使用方法について、サポートが必要な場合や追加の質問がある場合は、サポートまたは担当営業にご連絡ください。
Last updated