APIs Overview (RFC 060)
A period when the community can review the RFC (comment Docs).
Document Maintainers: Andi Gabriel Tan 2022. List of other contributors in Annex. 1.
Copyright: MIT license
Copyright© 2018-2024 Axiologic Research and Contributors.
This document is licensed under MIT license.
Abstract
This RFC summarizes the different API spaces available for Javascript client-side applications.
1. Get started
In order to use the API, it is need to call the function opendsu.loadApi(apiSpaceName), where opendsu is the folder containing the code for the API and “apiSpaceName” is one of the mandatory APIs space names in the list below.
1.1 API Spaces Summary
| API Space | Purpose |
|---|---|
| Anchoring | Anchoring service |
| BDNS | Handling Blockchain Domain Name Service |
| Bricking | Bricks Storages |
| Cache | Utilities for caching |
| Config | Utilities for openDSu environment configurations |
| Credentials | |
| Crypto | Recommended Crypto APIs |
| DB | DSU based databases |
| DT | DSU Types |
| Enclave | Private data storage |
| Error reporting | Custom error management |
| HTTP | Http client APIs |
| KeySSI | KeySSI manipulation |
| Ledger | |
| lock | New |
| m2dsu | Message To DSU operations Mapping Engine |
| mq | KeySSIs based Message Queues |
| Notifications | KeySSIs based Notifications |
| OAuth | |
| Resolver | Obtain DSU Representations using a resolver and handlers. |
| SC | Security Context |
| System | This API space allows the user to configure environment variables of the OpenDSU system. |
| utils | OpenDSU related utility APIs |
| w3cdid | |
| workers | NEW |
//Load openDSU environment
require("../privatesky/psknode/bundles/openDSU");
//Load openDSU SDK
const opendsu = require("opendsu");
//Load the API space of your choice
const resolver = opendsu.loadApi("resolver");
const keyssispace = opendsu.loadApi("keyssi");
const http = opendsu.loadApi("http");
}
How to use
2. Operations on DSUs
Click here to know all operations available on DSU objects
3. Operations on KeySSIs
Click here to know all common operations available for every KeySSI
There are also family-specific functions that you can find on the dedicated pages of each family.
Contributors
-
Axiologic Research: New content and improvements. Original texts under PharmaLedger Association and Novartis funding. MIT licensed content accordingly with the contracts. Publish and maintain the www.opendsu.org site.
-
PharmaLedger Project: Review, feedback, observations, new content, and corrections MIT licensed accordingly with the consortium agreements.
- PrivateSky Research Project: MIT licensed content accordingly with the contracts. https://profs.info.uaic.ro/~ads/PrivateSky/
Annex 1. Contributors
| Current Editors | |
|---|---|
| Sînică Alboaie | sinica.alboaie@axiologic.net |
| Cosmin Ursache | cosmin@axiologic.net |
| Teodor Lupu | teodor@axiologic.net |
| Andi-Gabriel Tan | andi@axiologic.net |
| Contributors Axiologic Research | |
| Adrian Ganga | adrian@axiologic.net |
| Andi-Gabriel Țan | andi@axiologic.net |
| Cosmin Ursache | cosmin@axiologic.net |
| Daniel Sava | daniel@axiologic.net |
| Nicoleta Mihalache | nicoleta@axiologic.net |
| Teodor Lupu | teodor@axiologic.net |
| Valentin Gérard | valentin@axiologic.net |
| PrivateSky Contributors | |
| Alex Sofronie | alsofronie@gmail.com(DPO) |
| Cosmin Ursache | cosmin@axiologic.net(UAIC) |
| Daniel Sava | daniel@axiologic.net(HVS, AQS) |
| Daniel Visoiu | visoiu.daniel.g@gmail.com(SGiant) |
| Lenuta Alboaie | lalboaie@gmail.com(UAIC) |
| Rafael Mastaleru | raf@rms.ro (RMS) |
| Sînică Alboaie | sinica.alboaie@axiologic.net(UAIC) |
| Vlad Balmos | vlad.balmos@gmail.com(Code932) |
| PharmaLedger Contributors | |
| Ana Balan | bam@rms.ro (RMS) |
| Bogdan Mastahac | mab@rms.ro (RMS) |
| Cosmin Ursache | cos@rms.ro (RMS) |
| Rafael Mastaleru | raf@rms.ro (RMS) |