Saltar al contenido principal
Version: 0.0.3

Extrimian SSI Service API

Introducción

Extrimian SSI Service API es una herramienta que simplifica la integración con SSI y nos ayuda a alcanzar nuestros objetivos principales: la generación de un DID, la emisión, obtención y verificación de credenciales verificables, todo ello con el fin de reducir la complejidad del proceso.

Aclaraciones

La API es una interfaz de programación de aplicaciones basada en la arquitectura REST, que permite la comunicación cliente-servidor a través del protocolo HTTP. Esto significa que la API expone endpoints a los cuales se puede acceder mediante solicitudes HTTP, utilizando cualquier cliente que implemente este protocolo, como navegadores web, clientes REST personalizados, o incluso herramientas como Swagger.

  • Diferencia entre API REST y SDK

Es fundamental comprender la diferencia entre una API REST y un SDK. Mientras que una API REST, como la de Extrimian, se enfoca en la comunicación directa entre el cliente y el servidor mediante solicitudes HTTP, un SDK proporciona una suite de herramientas y librerías que facilitan aún más el desarrollo de software, permitiendo a los desarrolladores integrarse con la API sin necesidad de realizar estas solicitudes directamente. En Extrimian también podemos ayudarte con un SDK.

Requisitos previos

Para hacer uso de este este servicio deberas obtener un id y una API_KEY. Para ello debes dirigirte a https://idconnect.extrimian.com/, crear tu usuario y luego solicitar el servicio SSI API. Obtendrás una url como la siguiente, donde podrás obtener los datos mencionados: https://idconnect.api.extrimian.com/{id}/ssi?apikey=API_KEY

Estructura

La API de Extrimian expone una serie de endpoints que se encuentran agrupados en tres categorías: credenciales verificables, identificadores descentralizados (DIDs) y sistemas de mensajería.

  1. Credenciales Verficables con firma BBS

Las credenciales verificables son utilizadas por el protocolo de Quark ID, permitiendo la aplicación de Zero Knowledge Proof y Selective Disclosure. Dentro de esta categoría, se destacan operaciones como la generación de flujos de invitación, la creación de mensajes en forma de códigos QR para autenticación de usuarios, y la gestión de estas credenciales. Estas operaciones habilitan un nivel avanzado de privacidad y seguridad en la verificación de identidades digitales.

  1. Identificadores Descentralizados (DIDs)

La sección de DIDs de la API permite la creación y gestión de identificadores únicos que facilitan la creación de documentos digitales y la posibilidad de listarlos basados en un DID específico. Estos identificadores son fundamentales para la interoperabilidad y la confianza en sistemas descentralizados, permitiendo resolver documentos de identidad de manera pública y transparente.

  1. Mensajería

La funcionalidad de mensajería de la API de Extrimian posibilita la comunicación directa entre DIDs, permitiendo el intercambio de mensajes y la realización de flujos de comunicación seguros. Esta característica es esencial para aplicaciones que requieren interacciones confiables entre usuarios en entornos descentralizados.

License

Apache 2.0