API経由で家族向けプランを提供

ビジネスアカウント関連の無料ファミリープラン作成API

このAPIは、Keeper Security Government Cloudリージョンに導入されているKeeperパートナーおよびエンタープライズ顧客向けです。

概要

エンタープライズ顧客向けに、ファミリープランをプロビジョニングするAPIを用意しています。REST APIを使ってカスタムアプリケーションの構築や連携ができます。

APIの機能

Provision Family Plans APIエンドポイントは、エンタープライズアカウントとMSPパートナーがKeeperファミリーライセンスを登録するためのものです。このエンドポイントでは、以下の製品/アドオン付きの1年間のライセンスを作成できます。

• Keeperファミリープラン
• BreachWatch (ダークウェブ監視)
• 10GBファイルストレージ

Keeperファミリーライセンスの全機能については、以下のページをご参照ください。

このAPIを利用するには、サポート担当者に連絡してAPIキーを申請してください。発行されたキーは、Keeperボルト内のレコードとして共有されます。

API定義

get

This is an API endpoint for partners to register Keeper Family licenses.This endpoint will create a 1 year license with the following Product/Add-ons -- Keeper Family,BreachWatch, 10GB File Storage

クエリパラメータ

transaction_idstring · 最小: 1必須

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

first_namestring · 最小: 1必須

First name of user

last_namestring · 最小: 1オプション

Last name of user

emailstring · 最小: 1必須

Email of user

hashstring · 最小: 1必須

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

partner_namestring · 最小: 1必須

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

レスポンス

200

OK

application/json

successbooleanオプション

order_numberstringオプション

Keeper Order Number for reference

vault_urlstringオプション

Link to send to the User to create the vault account with the email used in this API call

400

Bad Request

application/json

401

Unauthorized

application/json

get/create-license

GET /bi_api/v1/services/partner/create-license?transaction_id=text&first_name=text&email=text&hash=text&partner_name=text 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を試す場合は、関連するYAML定義を以下からダウンロードしてください。

SwaggerでのAPI探索について詳しくは、以下をご参照ください。

APIエクスプローラ - Swagger

これらの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?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);
  });