API経由での学生プランの提供
ビジネスアカウントに関連した無料の学生プランを作成するためのAPIアクセス
このAPIを通じて可能になる主なユースケースは、組織内の学生のための無料の「Keeper Unlimited」アカウントをプロビジョニングすることです。
概要
Keeperは法人のお客様に学生プランをプロビジョニングするためのAPIを提供しています。Keeperはカスタムアプリケーションを構築し、学生プランをプロビジョニングするための統合を可能にするREST APIを提供しています。
APIの機能
学生プランAPIエンドポイントは、大学が追加費用なしで大学内の学生のために「Keeper Unlimited」アカウントを登録するためのものです。このエンドポイントは以下の製品/アドオンと1年間のライセンスを作成します。
Keeper Unlimited
BreachWatch
10GBファイルストレージ
Keeper Unlimitedライセンス機能の詳細リストについては、こちらのページをご参照ください。
このAPIにアクセスするには、Keeper担当者に連絡してAPIキーをリクエストしてください。これはKeeperのレコードで安全に共有されます。
API 定義
This is an API endpoint for partner to register Keeper Unlimited licenses.This endpoint will create a 1 year license with the following Product/Add-ons -- Keeper Unlimited,BreachWatch, 10GB File Storage
Partner Transaction Id (external Id used by the partner as a reference)
First name of user
Last name of user
Email of user
Salted hash, hash = SHA256.hexdigest.bytesToHex(email + salt )
Keeper will provide the expected partner name along with the salt ("secret")
For Student API product type must be equal to 4.
OK
Bad Request
Unauthorized
GET /bi_api/v1/services/partner/create-license?transaction_id=text&first_name=text&email=text&hash=text&partner_name=text&product_type=1 HTTP/1.1
Host: keepersecurity.com
Accept: */*
{
"success": true,
"order_number": "12345678-1234",
"vault_url": "dev.keepersecurity.com/vault/#"
}追加API詳細
APIパラメータ
必要なパラメータの詳細については、こちらをご覧ください。
APIパラメータAPIレスポンスコード
レスポンスコードの詳細については、こちらをご覧ください。
APIレスポンスコードAPI エクスプローラ
postmanやswaggerエディタのような別のツールでAPIを調査したい場合は、APIの関連するYAML定義を以下からダウンロードしてください。
swaggerを使ったAPI探索の詳細については、こちらをご覧ください。
APIエクスプローラ - SwaggerAPIを使用したスクリプト例
サンプルnode.js スクリプト
以下のサンプルを使って、お使いの環境での実装方法をご確認ください。
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?product_type=4&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);
});最終更新