API経由での学生プランの提供

ビジネスアカウントに関連した無料の学生プランを作成するためのAPIアクセス

もしあなたが学生で、無料のKeeperアカウントをご希望の場合、学校のIT部門にご連絡ください。Keeperアカウントをプロビジョニングするには、以下の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 定義

get

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

Query parameters

transaction_idstring · min: 1required

Partner Transaction Id (external Id used by the partner as a reference)

first_namestring · min: 1required

First name of user

last_namestring · min: 1optional

Last name of user

emailstring · min: 1required

Email of user

hashstring · min: 1required

Salted hash, hash = SHA256.hexdigest.bytesToHex(email + salt )

partner_namestring · min: 1required

Keeper will provide the expected partner name along with the salt ("secret")

product_typeinteger · min: 4required

For Student API product type must be equal to 4.

Responses

application/json

application/json

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url 'https://keepersecurity.com/bi_api/v1/services/partner/create-license?transaction_id=text&first_name=text&email=text&hash=text&partner_name=text&product_type=1'

200

400

401

200

Success

Error

Success

{
  "success": true,
  "order_number": "12345678-1234",
  "vault_url": "dev.keepersecurity.com/vault/#"
}

OK

追加API詳細

APIパラメータ

必要なパラメータの詳細については、こちらをご覧ください。

APIパラメータ

APIレスポンスコード

レスポンスコードの詳細については、こちらをご覧ください。

APIレスポンスコード

API エクスプローラ

postmanやswaggerエディタのような別のツールでAPIを調査したい場合は、APIの関連するYAML定義を以下からダウンロードしてください。

4KB

StudentPlan.yaml

swaggerを使ったAPI探索の詳細については、こちらをご覧ください。

APIエクスプローラ - Swagger

これらのAPIの使用方法についてサポートが必要な場合や追加の質問がある場合は、サポートまたは営業担当者にお問い合わせください。

APIを使用したスクリプト例

サンプル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);
  });