piianovaultrestapi v1.0.5

PiianoVaultRESTAPI Typescript SDK 1.0.0

The Typescript SDK for PiianoVaultRESTAPI.

• API version: 1.0
• SDK version: 1.0.0

Table of Contents

• About the API
• Requirements
• Installation
  • Dependencies
• API Endpoint Services
• API Models
• Testing
• Configuration
• Sample Usage
• License

About the API

--- sidebar_position: 1 sidebar_label: Overview slug: / --- # Introduction The Piiano Vault REST API enables you to access and manage collections, objects, tokens, users, policies, and other resources within Piiano Vault in a simple, programmatic way using conventional HTTP requests and standard HTTP response codes. The API follows RESTful conventions when possible, with most operations performed by GET, POST, PUT, PATCH, and DELETE requests. Request and response bodies are JSON-encoded. However, for collection operations, an SQL-like PVSchema encoding is available. This API reference provides details for each operation available in the API. When you install a local copy of Vault, you can try each operation using Send API request. An OpenAPI specification is available in YAML and JSON formats and can be used to generate client code for the API.

Requirements

You should have node and Typescript installed.

Installation

Use this command to install the SDK using NPM:

npm install piianovaultrestapi  

API Endpoint Services

All URIs are relative to http://localhost:8123. Click the service name for a full list of the service methods.

API Models

A list documenting all API models for this SDK.

Testing

To run the tests for the SDK execute the following command from within the package directory:

npm run test

Configuration

Your SDK may require some configuration changes.

Sample Usage

Here is a simple program demonstrating usage of this SDK that is also available in the sample.js file in this directory. You can run it with node sample.js.

import { PiianoVaultRESTAPI } from './src';


const sdk = new PiianoVaultRESTAPI();

(async () => {
  const result = await sdk.System
    .getKms();
  console.log(result);
})();
 

To see what other functions this SDK is capable of, look inside dist/services/readme.md