Solidus
Geliştirici dokümantasyonu

Aracı URL'nizi buraya yönlendirin — tek satır.

Herhangi bir DIDComm v2 ajanı relay üzerinden aracılık edebilir — CoordinateMediation 2.0, Pickup Protocol 3.0 ve iletme yönlendirmesi, hepsi standartlaştırma sürecinde. Aşağıdaki yönetim API'si okuma/yönetim amaçlıdır; dokümantasyon ücretsizdir, okumak için giriş yapmanıza gerek yok.

Bir API anahtarı alın
Hızlı başlangıç

Aracı URL'sini relay'e yönlendirin.

Temel akış için kurulacak ayrı bir SDK yoktur — ajanınızın aracı URL'sini ayarlayın ve mediate-request komutunu çalıştırın. Relay aracılığı onaylar, bir anahtar listesi döndürür ve yönlendirmeye başlar.

Aracı uç noktası
1# any DIDComm v2 agent — point its mediator URL here:
2MEDIATOR_URL=https://relay.solidus.network/didcomm

Testnet · lansman öncesi — aşağıdaki framework adaptörleri planlanmaktadır ve lansmanla birlikte kullanıma sunulacaktır.

Adaptörler

Zaten çalıştırdığınız ajanlarla uyumludur.

Framework adaptörleri planlanmaktadır ve lansmanla birlikte kullanıma sunulacaktır — henüz npm'e yayınlanmadı. Ham DIDComm v2 uç noktası, uyumlu her ajan için bugünden itibaren çalışır.

Credo-TS
1// @solidus/credo-relay-adapter — planned, ships with launch
2import { Agent } from '@credo-ts/core'
3import { MediationRecipientModule } from '@credo-ts/didcomm'
4

5const agent = new Agent({
6  modules: {
7    mediationRecipient: new MediationRecipientModule({
8      mediatorInvitationUrl: 'https://relay.solidus.network/invite',
9    }),
10  },
11})
API referansı

Yönetim API'si.

Yönetim API'si — okuma/yönetim; dokümantasyon ücretsiz, giriş gerekmez. Aşağıdaki uç noktalar aracılıkları, anahtar listelerini, kuyruk durumunu ve kimlik bilgisi geçidi (credential-gate) politikalarını kapsar; ayrıca başka hiçbir aracının yayınlamadığı zincir üstü çözümleme izini de içerir.

Aracılıklar

GET
/v1/mediations

Tüm aracılıkları listeler; duruma ve kimlik bilgisi geçidine (credential-gate) göre filtrelenebilir.

GET
/v1/mediations/:id

Tek bir aracılığı getirir — durum, geçit sonucu, anahtar listesi boyutu, kuyruk derinliği.

Örnek yanıt
{
  "id": "med_a7f2c9",
  "recipient_did": "did:solidus:z6MkjWn4qYdSx2vTbCpF7kMuGe5hZa9rLoDiB3yXf8EwVsQ6",
  "state": "granted",
  "gate": { "policy": "KYC-verified recipients", "state": "pass" },
  "keylist_size": 3,
  "queued": 812,
  "delivered_24h": 96,
  "granted_ago": "2d",
  "protocols": ["coordinate-mediation/2.0","messagepickup/3.0"]
}
GET
/v1/mediations/:id/keylist

Alıcının yönlendirme anahtarları ve anahtar başına yönlendirilen mesaj sayısı.

POST
/v1/mediations/:id/grant

Operatör geçersiz kılması — bekleyen bir aracılığı onaylar (otomatik geçit kararının üzerine).

POST
/v1/mediations/:id/deny

Operatör geçersiz kılması — bir aracılığı gerekçe belirterek reddeder.

POST
/v1/mediations/:id/revoke

Bir aracılığı sonlandırır ve anahtar listesini kaldırır.

DELETE
/v1/mediations/:id/keylist/:key

Bir aracılık anahtar listesinden tek bir yönlendirme anahtarını kaldırır.

Kuyruk ve mesajlar

GET
/v1/queue/status

Kuyruk derinliği, kuyruktaki en eski mesajın yaşı ve duruma göre sayılar.

GET
/v1/messages

Kuyruktaki/teslim edilmiş zarfları listeler (yalnızca meta veri — asla şifreli metin değil); duruma/protokole/alıcıya göre filtreleyin.

GET
/v1/delivery-log

Operatör olay akışı — alıcıya veya aracılığa göre kapsamlandırılır. Yalnızca meta veri.

Politikalar ve geçit kontrolü

GET
/v1/policies

Kimlik bilgisi geçidi (credential-gate) politikalarını listeler — gerekli VC türü, düzenleyici (issuer), ifşa (disclosure), uygulama kapsamı (applies-to).

POST
/v1/policies

Bir kimlik bilgisi geçidi (credential-gate) politikası oluşturur.

PATCH
/v1/policies/:id

Bir politikayı etkinleştirir veya devre dışı bırakır.

POST
/v1/policies/test

Bir kimlik bilgisini geçide karşı test eder — canlı mediate-grant/teslimat yolunun kullandığı AYNI sunucu tarafı kontrolü.

PUT
/v1/policies/rate-limit

DID başına hız sınırını ayarlar (dakika başına + burst).

PUT
/v1/policies/retention

Mesaj saklama süresini ayarlar (gün + purge-on-ack).

Anahtarlar ve webhooklar

GET
/v1/api-keys

Operatör API anahtarlarını listeler (ham değer asla döndürülmez).

POST
/v1/api-keys

Bir API anahtarı oluşturur — ham slk_ değeri yalnızca bir kez döndürülür.

DELETE
/v1/api-keys/:id

Bir API anahtarını iptal eder.

GET
/v1/webhooks

Webhook uç noktalarını + son teslimat durumunu listeler.

PUT
/v1/webhooks

Bir webhook uç noktasını 7 kanonik olaya abone eder (HMAC imzalı, SSRF güvenli).

Yönlendirme çözümlemesi

GET
/v1/resolutions/:did

did:solidus yönlendirme anahtarı ve uç nokta çözümleme izi — zincir üstü mü yoksa önbellekten mi geldiğini gösterir, blok referanslıdır. Başka hiçbir aracı bunu sunmaz.

Örnek yanıt
{
  "did": "did:solidus:z6MkjWn4qYdSx2vTbCpF7kMuGe5hZa9rLoDiB3yXf8EwVsQ6",
  "routing_key": "z6LSfj9q…QtU0S1",
  "endpoint": "https://relay.solidus.network/didcomm",
  "source": "on-chain",
  "block": 4827391,
  "resolved_ago": "4m"
}
POST
/v1/resolutions/:did/re-resolve

Önbelleği atlayarak yeni bir zincir üstü çözümleme zorlar.

Webhooklar

Abone olabileceğiniz olaylar.

Bir API anahtarınız olduğunda, operatör konsolundan bir webhook uç noktası yapılandırın ve bunlardan herhangi birine abone olun.

OlayNe zaman tetiklenir
mediation.grantedBir mediate-request onaylanır ve alıcının anahtar listesi oluşturulur.
mediation.deniedBir mediate-request reddedilir — genellikle bir kimlik bilgisi geçidi (credential-gate) engellemesi nedeniyle.
message.queuedYönlendirilen bir zarf, çevrimdışı olan bir alıcı için beklemeye alınır.
message.deliveredKuyruktaki bir mesaj alınır veya canlı bir bağlantı üzerinden teslim edilir.
delivery.failedCanlı bir bağlantıya yapılan teslimat denemesi başarısız olur ve yeniden denenecektir.
gate.blockedBir kimlik bilgisi geçidi (credential-gate) politikası, aracılığı veya teslimatı reddeder.
resolution.failedZincir üstü bir did:solidus çözümlemesi başarısız olur ve aracı önbelleğe alınmış bir uç noktaya geri döner.

Bir API anahtarı alın ve bir aracı URL'si yönlendirin.

Başlamak ücretsizdir — 1 aracı DID, günde 1.000 mesaj, satış görüşmesi yok.

Bir API anahtarı alın
Dokümantasyon — Solidus Relay