Optionaloptions: ApiClientConfigurationAn instance of API client.
Construct custom protocol launch URI that can be opened by user to launch the application.
import { apiClient } from '@octosign/client';
const client = apiClient();
console.log(client.createLaunchURI());
// => autogram://listen/37200/https%3A%2F%2Fexample.com/3a2bca8d73c62e75177fa877de283cc0c96cdf3ba08f8eb878a96da93de3d798/260372071
URL that can be opened by the user.
Retrieve server info with its current state.
import { apiClient } from '@octosign/client';
const client = apiClient();
console.log(await client.info());
// => { version: '1.2.3', status: 'READY' }
Info about the server and its current state.
Sign a document via the legacy POST /sign endpoint (all Autogram
versions; one document only).
import { apiClient } from '@octosign/client';
const client = apiClient();
console.log(await client.signLegacy({ content: '<?xml version="1.0"?><Document><Title>Lorem Ipsum</Title></Document>' }));
// => { content: '...signed document...' }
Optionalfilename?: stringFilename of the original file to be signed. Is used to name the file inside ASiC container. If not provided with ASiC container, the file is named detached-file inside the container. If XML Document container is created, filename extension is set to .xdcf or filename is set to document.xdcf if empty.
Optional signature parameters.
OptionalautoLoadEform?: booleanTry to find XSD and XSLT for a given eForm and load them automatically. Useful for visualizing and signing eForms. If true, schema, transformation, conatinerXmlns, container, packaging, and identifier parameters are ignored. If resources are not found, the response is 422. If provided document is an ASiC_E container conatining XML Datacontainer or it is an XML Datacontainer itself, XSLT found is used for visualiztion of signing document. Also, XSD and XSLT hashes are compared with hashes of XSD and XSLT found in XML Data Container EForm. If they differ, the response is 422. If the provided document is an XML document, Autogram will try to parse xmlns from root element and find resources based on its value. If successful, XML Datacontainer with xmls="http://data.gov.sk/def/container/xmldatacontainer+xml/1.1" is created, the document is validated against the XSD and visualized using the XSLT. If XSD validation fails, the response is 422. The XSLT transformation is found based on transformationLanguage (defaults to user preferred), transformationMediaDestinationTypeDescription (default XHTML, then HTML, then TXT), and transformationTargetEnvironment. If multiple transformations meet the criteria, the first one found is used.
OptionalcheckPDFACompliance?: booleanOptionalcontainer?: "ASiC_E"OptionalcontainerXmlns?: "http://data.gov.sk/def/container/xmldatacontainer+xml/1.1"XML namespace for the XML Datacontainer. Specifies if xmldatacontainer should be created from XML. Doesn't create xmldatacontainer if payloadMimeType is application/vnd.gov.sk.xmldatacontainer+xml already. Accepts http://data.gov.sk/def/container/xmldatacontainer+xml/1.1 only. Defaults to null. Is ignored with autoLoadEform true.
OptionaldigestAlgorithm?: "SHA256" | "SHA384" | "SHA512"OptionalembedUsedSchemas?: booleanWhen creating XML Datacontainer, parameter indicates whether to embed XSD and XML or reference them. Practically this should be only used for ORSR EForms in which case (when identifier contains "justice.gov.sk/Forms") this parameter is overridden to true.
Optionalen319132?: booleanOptionalfsFormId?: stringSpecific identifier for financnasprava.sk EForms. For example, 792_772 is an identifier of "Danove priznanie - riadne".
Optionalidentifier?: stringOptional identifier of the document template. Required if containerXmlns is http://data.gov.sk/def/container/xmldatacontainer+xml/1.1. Defaults to null. Is ignored with autoLoadEform true.
OptionalinfoCanonicalization?: OptionalkeyInfoCanonicalization?: Optionallevel?: Signature format PAdES is usable only with documents of type application/pdf. Format XAdES is usable with XML or with any file type if using an ASiC container.
If document is already signed (PAdES PDF or ASiC), this parameter is optional and signature format is decided based on the already signed document if empty.
For already signed documents, BASELINE_B or BASELINE_T can be used to add another signature of the same format as the existing signature but different level.
Optionalpackaging?: "ENVELOPED" | "ENVELOPING"Optional form of packaging used with XML. ENVELOPED adds the signature as a child of the root element while ENVELOPING wraps the XML in a new element. Only applies to XAdES signatures. Must be ENVELOPING when used without ASiC container and with non XML documents. Is ignored with autoLoadEform true.
OptionalpropertiesCanonicalization?: Optionalschema?: stringOptionalschemaIdentifier?: stringOptional identifier of the XML schema. The value is used in "UsedXSDReference" field inside created XML Datacontainer. If provided with autoLoadEform true, Autogram will try to find such schema. Default value is "http://schemas.gov.sk/form/
Optionaltransformation?: stringOptional XML transformation used to present the signing document to user and to compute digest used in "UsedPresentationSchemaReference" in "DigestValue" attribute inside created XML Datacontainer. Format (plaintext or base64) is dictated by payloadMimeType. Is ignored with autoLoadEform true.
OptionaltransformationIdentifier?: stringOptional identifier of the XML transformation. If provided with autoLoadEform true, Autogram will try to find such transformation. Default value is "http://schemas.gov.sk/form/
OptionaltransformationLanguage?: stringOptionaltransformationMediaDestinationTypeDescription?: "XHTML" | "HTML" | "TXT"Optional media destination type description of the XML transformation. If autoLoadEform is true, Autogram will try to find signing XSLT with this type. Otherwise transformation must be provided. Overrides value of the output method in provided or auto-loaded transformation which is used by default.
OptionaltransformationTargetEnvironment?: stringOptionalvisualizationWidth?: "sm" | "md" | "lg" | "xl" | "xxl"Optional width of the signing document visualization. Values are sm (640px), md (768px), lg (1024px), xl (1280px), xxl (1536px). The minimum visualization width is set to 640px. If the preferred visualization width is exceeds width of client's screen, the visualization width is set to the width of the client's screen.
Optional payload mime type, defaults to 'application/xml' - plaintext XML. Must reflect document content type so should be changed if content is not a plaintext XML.
Optional batch identifier. If provided, the document is signed inside the batch.
Optional AbortController used to cancel the request.
Signed document.
Sign one or more documents via POST /api/v1/sign (Autogram >= 2.8.0).
Multiple documents are signed together into a single ASiC_E container
("spoločná autorizácia dokumentov"). batchId may only be used with
exactly one document.
Documents (each with its own mimeType and optional xdcParameters), signature and presentation parameters.
Optional AbortController used to cancel the request.
Signed document (or ASiC_E container for multiple documents).
Wait for server to be in the requested state.
Repeatedly tries to get server info retrying
import { apiClient } from '@octosign/client';
const client = apiClient();
await client.waitForStatus('READY');
// => { version: '1.2.3', status: 'READY' }
Wanted status of the server.
Timeout in seconds before giving up and rejecting with error.
Delay before making next attempt after failure.
OptionalabortController: AbortControllerInfo about the server and its current state.
Octosign White Label API client for the app running in the server mode.
Example (es module and async/await)
All further examples use es module and async/await, but the library can be also used as commonjs module and using promises.
Example (commonjs and promises)