Ana içeriğe geç

REST API

Platform, tüm operasyonları RESTful bir API üzerinden sunar. API, Keycloak tabanlı kimlik doğrulama kullanır ve JSON formatında veri alışverişi yapar. API, Swagger UI üzerinden erişilebilen etkileşimli belgelerle OpenAPI 3.0.3 spesifikasyonunu takip eder.

API Yapısı​

v2 API, işlevsel modüllere ayrılmıştır:

Endpoint Hiyerarşisi
/api/v2/multi-agent
├── /holder            → Kimlik sahibi (Holder) operasyonları
├── /groups           → Ajan grubu yönetimi
├── /issuer            → Grup üzerinden kimlik düzenleyici (Issuer) operasyonları
└── /mediator         → Grup üzerinden arabulucu (Mediator) operasyonları

Tüm v2 rotaları Keycloak kimlik doğrulaması gerektirir.

Kök ve Sağlık Uç Noktaları​

MetotYolAçıklama
GET/DT Cloud SSI API Servisi için hoş geldin mesajı
GET/healthIssuer ve Holder ajanları için sağlık kontrolü
GET/health/metricsSistem ve işlem metrikleri
GET/docsSwagger UI dokümantasyonu
GET/docs.jsonJSON formatında OpenAPI spesifikasyonu

Holder - Kimlik Sahibi (/api/v2/multi-agent/holder)​

Bağlantı Yönetimi​

MetotYolAçıklama
POST/holder/connections/receive-invitationDavet kabul etme
GET/holder/connectionsBağlantıları listeleme
GET/holder/connections/activeAktif bağlantıları listeleme
GET/holder/connections/{connectionId}Bağlantı detaylarını getirme
DELETE/holder/connectionsBağlantıları silme

Kimlik (Credential) Yönetimi​

MetotYolAçıklama
GET/holder/credentials/offersKimlik tekliflerini getirme
POST/holder/credentials/offers/{credExId}/acceptKimlik teklifini kabul etme
GET/holder/credentials/exchangesKimlik değişimlerini listeleme
GET/holder/credentials/walletCüzdan kimliklerini getirme
GET/holder/credentials/wallet/with-revocationİptal durumuyla birlikte kimlikleri getirme
POST/holder/credentials/proposalsKimlik teklifi oluşturma
POST/holder/credentials/requestKimlik isteği oluşturma
DELETE/holder/credentials/offersKimlik tekliflerini silme
DELETE/holder/credentials/exchangesKimlik değişimlerini silme

İptal (Revocation) İstekleri​

MetotYolAçıklama
POST/holder/revocation-requestsİptal isteği oluşturma
GET/holder/revocation-requestsİptal isteklerini listeleme
GET/holder/revocation-requests/{requestId}Belirli bir iptal isteğini getirme

Grup Yönetimi (/api/v2/multi-agent/groups)​

MetotYolAçıklama
POST/groupsAjan grubu oluşturma
GET/groupsAjan gruplarını listeleme
GET/groups/{groupId}Ajan grubunu getirme
PUT/groups/{groupId}Ajan grubunu güncelleme
DELETE/groups/{groupId}Ajan grubunu silme
POST/groups/{groupId}/agents/{tenantId}Gruba ajan ekleme
DELETE/groups/{groupId}/agents/{tenantId}Gruptan ajan çıkarma
GET/groups/{groupId}/select-agentGruptan ajan seçme
POST/groups/{groupId}/auto-scaleOtomatik ölçeklendirmeyi yapılandırma

Issuer - Kimlik Düzenleyici (/api/v2/multi-agent/groups/{groupId}/issuer)​

Bağlantı Yönetimi​

MetotYolAçıklama
POST/issuer/connections/create-invitationDavet oluşturma
GET/issuer/connectionsBağlantıları listeleme
GET/issuer/connections/{connectionId}Bağlantı detaylarını getirme

Şema Yönetimi​

MetotYolAçıklama
POST/issuer/schemasŞema oluşturma
GET/issuer/schemasŞemaları listeleme

Kimlik Tanımı (Credential Definition) Yönetimi​

MetotYolAçıklama
POST/issuer/credential-definitionsKimlik tanımı oluşturma
GET/issuer/credential-definitionsKimlik tanımlarını listeleme

Kimlik Düzenleme (Issuance)​

MetotYolAçıklama
POST/issuer/credentials/issue-by-schemaŞema ile kimlik düzenleme
POST/issuer/credentials/send-offerKimlik teklifi gönderme
GET/issuer/credentials/exchangesKimlik değişimlerini listeleme
POST/issuer/credentials/exchanges/{credExId}/issueDeğişimden kimlik düzenleme

İptal (Revocation) Yönetimi​

MetotYolAçıklama
POST/issuer/revocation/revokeKimlik iptal etme
GET/issuer/revocation/registriesİptal kayıtlarını listeleme
GET/issuer/revocation/registries/{revRegId}İptal kaydı detaylarını getirme

İspat/Doğrulama​

MetotYolAçıklama
GET/issuer/proofs/recordsİspat kayıtlarını listeleme
POST/issuer/proofs/records/{presExId}/verifyİspat doğrulama
GET/issuer/proofs/transcriptsTranskript ispatlarını getirme
GET/issuer/proofs/diplomasDiploma ispatlarını getirme

Cüzdan Yönetimi​

MetotYolAçıklama
POST/issuer/wallet/register-public-didGenel DID kaydetme
GET/issuer/wallet/public-didGenel DID'yi getirme
GET/issuer/wallet/didsDID'leri listeleme

Arabulucu (/api/v2/multi-agent/groups/{groupId}/mediator)​

Bağlantı Yönetimi​

MetotYolAçıklama
POST/mediator/connections/create-invitationDavet oluşturma
GET/mediator/connectionsBağlantıları listeleme
GET/mediator/connections/{connectionId}Bağlantı detaylarını getirme
DELETE/mediator/connections/{connectionId}Bağlantı silme
DELETE/mediator/connectionsTüm bağlantıları silme

Arabuluculuk (Mediation) Yönetimi​

MetotYolAçıklama
GET/mediator/mediation/recordsArabuluculuk kayıtlarını listeleme
GET/mediator/mediation/records/{mediationId}Arabuluculuk kaydını getirme
GET/mediator/mediation/keylistsArabuluculuk anahtar listelerini getirme
POST/mediator/mediation/records/{mediationId}/grantArabuluculuğu onaylama
POST/mediator/mediation/records/{mediationId}/denyArabuluculuğu reddetme
DELETE/mediator/mediation/records/{mediationId}Arabuluculuk kaydını silme
DELETE/mediator/mediation/recordsTüm arabuluculuk kayıtlarını silme

API Akışı​

Hata Kodları​

KodAçıklama
200Başarılı
201Oluşturuldu
400Hatalı istek
401Yetkisiz
403Yasaklı
404Bulunamadı
500Sunucu hatası

Özet​

MetrikDeğer
API Sürümüv2
Kimlik DoğrulamaKeycloak
DokümantasyonSwagger UI ile OpenAPI 3.0.3
Ajan TipleriHolder (Holder), Issuer (Issuer), Arabulucu (Mediator)