All pages
Powered by GitBook
1 of 4

API Troubleshooting

This section contains the following documents in providing more details on troubleshooting with the API:

The API parameters required to make a successful API call:

API Parameters

API response code

API Response Codes

API Explorer guide with Swagger

API Explorer - Swagger

API Parameters

Prerequisite

Prior to working with the API endpoints, your Keeper representative will provided you with the following:

  • Partner Name

  • Salt

This information will be needed to get a successful response by the API endpoint.

If you don't have the Partner Name or Salt, contact your Keeper representative.

API Parameters

Keeper Provision APIs require the following API Parameters to be passed with the API endpoint in order to get a successful request:

Parameter
Description

transaction_id (string)

Partner Transaction ID. This is a custom ID that you create for your reference. Example: "0001", "user1"

first_name (string)

User's First Name

last_name (string) (optional)

User's Last Name

email (string)

User's Email This is the email that will receive the invitation email to create an account

hash (string)

This is the salted hash you generate by hashing the User's email and Salt key provided by Keeper with SHA-256: hash = SHA256.hexdigest.bytesToHex(email + salt )

partner_name (string)

The expected Partner Name is provided by your Keeper representative

API Response Codes

The Provision APIs respond to the API endpoints with the following:

Response
Description
Example Format

200

Ok

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

400

Bad Request

{
  "success": false,
  "message": "Invalid request - Missing required fields"
}

401

Unauthorized

{
  "success": false,
  "message": "Invalid Hash Value - UnAuthorized"
}

API Explorer - Swagger

Overview

This document will detail using Swagger to help you understand the Family and Student Plans APIs and test your own examples.

API Explorer with Swagger

  1. Go to https://editor.swagger.io/

  2. Visit & Download the YAML file for the provision endpoint you want to explore: Family Plans Student Plans

  3. In Swagger, click on File > Import and select the YAML file downloaded in step 2

  4. After importing the YAML file, the swagger website should show the API configuration defined in the YAML file on the Left screen, and the corresponding API explorer on the right side:

This example uses the Family Plan's YAML File

  1. Expanding the API call on the right side will provide more information on the API endpoint's parameters and responses

  1. To being testing out the API endpoint, click on the "Try it out" button

  1. After filling out the values for the API Parameters, clicking on "Execute" will execute the API call:

For detailed information on the API parameters and how to define them, visit this page

  1. After executing, you can scroll to the Response section to view the results