Extrimian SSI Service API
Introduction
Extrimian SSI Service API is a tool that simplifies integration with SSI and helps us achieve our main objectives: the generation of a DID, issuing, obtaining, and verifying verifiable credentials, all with the aim of reducing the complexity of the process.
Clarifications
The API is an Application Programming Interface based on REST architecture, which allows client-server communication via the HTTP protocol. This means that the API exposes endpoints that can be accessed through HTTP requests using any client implementing this protocol, such as web browsers, custom REST clients, or even tools like Swagger.
- Difference between REST API and SDK
It is crucial to understand the difference between a REST API and an SDK. While a REST API, like Extrimian's, focuses on direct communication between the client and the server through HTTP requests, an SDK provides a suite of tools and libraries that further facilitate software development, allowing developers to integrate with the API without needing to make these requests directly. At Extrimian, we can also assist you with an SDK.
Prerequisites
To use this service, you need to obtain an id and an API_KEY. To do this, you must go to https://idconnect.extrimian.com/, create your user, and then request the SSI API service.
You will receive a URL like the following, where you can obtain the mentioned data: https://idconnect.api.extrimian.com/{id}/ssi?apikey=API_KEY
Structure
The Extrimian API exposes a series of endpoints grouped into three categories: verifiable credentials, decentralized identifiers (DIDs), and messaging systems.
- Verifiable Credentials with BBS Signature
Verifiable credentials are used by the Quark ID protocol, allowing the application of Zero Knowledge Proof and Selective Disclosure. Within this category, operations such as generating invitation flows, creating messages in the form of QR codes for user authentication, and managing these credentials stand out. These operations enable an advanced level of privacy and security in digital identity verification.
- Decentralized Identifiers (DIDs)
The DIDs section of the API allows the creation and management of unique identifiers that facilitate the creation of digital documents and the ability to list them based on a specific DID. These identifiers are fundamental for interoperability and trust in decentralized systems, allowing identity documents to be resolved publicly and transparently.
- Messaging
The messaging functionality of the Extrimian API enables direct communication between DIDs, allowing the exchange of messages and the performance of secure communication flows. This feature is essential for applications requiring reliable interactions between users in decentralized environments.