restpkicore-client

v1.0.3

Published

2 years ago

Classes to consume Lacuna Software REST PKI Core

Downloads

0High
0Medium
0Low

danilobispo

lacuna rest pki client api signature

RestPkiCore-Client for node.js

RestPkiCore-Client - node.js client lib for RestPkiCoreClient

API version: 1.10.1 RTM
Package version: 1.0.3
Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

Install it via:

npm install restpkicore-client --save

Getting Started

Please follow the installation instruction, then create and execute the following JS code:

import { ApiClient, SignatureSessionsApi, API_KEY_HEADER } from 'restpkicore-client';

var apiClient = ApiClient.instance;
apiClient.basePath = "https://core.pki.rest";
apiClient.defaultHeaders = API_KEY_HEADER;

new SignatureSessionsApi(apiClient).apiSignatureSessionsIdGet('3fa85f64-5717-4562-b3fc-2c963f66afa6', (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Run with the following code on terminal (remember to replace the filename!):

node --experimental-specifier-resolution=node yourcode.js

Documentation for API Endpoints

All URIs are relative to /

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- RestPkiCoreClient.ApplicationKeysController29Api | apiApplicationsAppIdApiKeysPost | POST /api/applications/{appId}/api-keys | RestPkiCoreClient.ApplicationsApi | apiApplicationsIdDefaultDocumentMetadataGet | GET /api/applications/{id}/default-document-metadata | Returns the set of metadata values that is currently added for documents created by a given application RestPkiCoreClient.ApplicationsApi | apiApplicationsIdDefaultDocumentMetadataPut | PUT /api/applications/{id}/default-document-metadata | Configures a set of metadata values to be added to each document created by the application RestPkiCoreClient.ApplicationsController29Api | apiApplicationsGet | GET /api/applications | RestPkiCoreClient.ApplicationsController29Api | apiApplicationsIdDelete | DELETE /api/applications/{id} | RestPkiCoreClient.ApplicationsController29Api | apiApplicationsIdGet | GET /api/applications/{id} | RestPkiCoreClient.ApplicationsController29Api | apiApplicationsNameAvailabilityGet | GET /api/applications/name-availability | RestPkiCoreClient.ApplicationsController29Api | apiApplicationsPost | POST /api/applications | RestPkiCoreClient.AuthenticationApi | apiV2AuthenticationCompletionPost | POST /api/v2/authentication/completion | Completes a certificate authentication RestPkiCoreClient.AuthenticationApi | apiV2AuthenticationPost | POST /api/v2/authentication | Prepares for a certificate authentication RestPkiCoreClient.CertificatesApi | apiCertificatesThumbprintSha256Get | GET /api/certificates/{thumbprintSha256} | Retrieves information about a X.509 certificate previously used to sign some document RestPkiCoreClient.DocumentKeysApi | apiDocumentKeysBatchPost | POST /api/document-keys/batch | Allocates a batch of document keys to be used later on document signatures RestPkiCoreClient.DocumentKeysApi | apiDocumentKeysKeyGet | GET /api/document-keys/{key} | Queries documents by key RestPkiCoreClient.DocumentKeysApi | apiDocumentKeysPost | POST /api/document-keys | Allocates a document key to be used later on a document signature RestPkiCoreClient.DocumentKeysApi | apiDocumentKeysUnusedGet | GET /api/document-keys/unused | Queries unused document keys RestPkiCoreClient.DocumentsApi | apiDocumentsIdGet | GET /api/documents/{id} | Retrieves a document's details RestPkiCoreClient.DocumentsApi | apiDocumentsIdSignersGet | GET /api/documents/{id}/signers | Retrieves the full information about each of a document's signers RestPkiCoreClient.DocumentsApi | apiDocumentsKeysKeyGet | GET /api/documents/keys/{key} | Finds a document's details by its key RestPkiCoreClient.SignatureInspectionApi | apiSignatureInspectionPut | PUT /api/signature-inspection | Inspects a signed file, returning information about its signers and metadata about the corresponding document (if signed on this instance) RestPkiCoreClient.SignatureSessionsApi | apiSignatureSessionsIdGet | GET /api/signature-sessions/{id} | Retrieves a signature session's details RestPkiCoreClient.SignatureSessionsApi | apiSignatureSessionsIdWhenCompletedGet | GET /api/signature-sessions/{id}/when-completed | Waits for the completion of a signature session RestPkiCoreClient.SignatureSessionsApi | apiSignatureSessionsPost | POST /api/signature-sessions | Creates a signature session

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme