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

ビジネスアカウントに関連する無料ファミリープランを作成するためのAPIアクセス

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

概要

Keeperは、企業顧客がファミリープランをプロビジョニングするためのAPIを提供します。Keeperは、カスタムアプリケーションを構築し、ファミリープランをプロビジョニングするために統合できるREST APIを提供します。

APIの機能

Provisionファミリープラン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

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")

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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'

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

FamilyPlan.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);
  });