Ana içeriğe geç

Gateway'e Genel Bakış

Her partner API çağrısı integration gateway üzerinden girer. Gateway, route'un var olup olmadığına, token gerektirip gerektirmediğine ve token'ınızın route'un istediği izni taşıyıp taşımadığına karar verir; ancak bundan sonra çağrıyı, client'ınızın kendi kontrollerini (sertifika, IP izin listesi, hız ve kullanım sınırları) uygulayıp işlemi çalıştıran integration servisine iletir.

┌────────┐ TLS (+ client cert) ┌──────┐ ┌─────────┐ ┌─────────────┐
│ Client │ ──────────────────────▶ │ Edge │ ──▶ │ Gateway │ ──▶ │ Integration │
└────────┘ └──────┘ └─────────┘ └─────────────┘

Gateway'in kontrolleri​

AdımKontrolRet
1Metot ve path gateway'in route izin listesinde404
2Korumalı route için: platform tarafından imzalanmış bir token içeren Authorization: Bearer <access_token> başlığı401
3Token, route'un istediği izinlerin tamamını taşıyor (her endpoint sayfası bunu Gerekli izin olarak listeler)403
4Token hâlâ client'ınızın geçerli access token'ı401

Ardından integration servisi sırasıyla şunları kontrol eder: token'ı yeniden, client sertifika gerektiriyorsa client sertifikanızı, IP izin listenizi, hız sınırını ve aylık kullanım sınırını. Bu retlerin gövdeleri için Hatalar sayfasına bakın.

İzin listesi varsayılan olarak reddeder. Listede olmayan bir route, servis onu uygulasa bile gateway'de 404 döner. Bu dokümantasyondaki her route izin listesindedir.

İzinler​

client_credentials grant'ı ile verilen bir token client'ınızda tanımlı scope'ları; password grant'ı ile verilen bir token ise supervisor'ın rol izinlerini taşır (bkz. Token Oluşturma). Bir endpoint 403 döndüğünde operatörden ilgili scope'u eklemesini isteyin.

Her korumalı route en az bir izin gerektirir. Birkaç admin route'u ayrıca servis tarafından platform sahibinin düğümüyle sınırlandırılmıştır; sayfaları bunu belirtir.

Herkese açık route'lar​

Bu route'lar Authorization başlığı gerektirmez:

RouteAmaç
GET /health, GET /v1/health, GET /v2/healthCanlılık kontrolleri
POST /v2/oauth/tokenToken verir. Bkz. Token Oluşturma
POST /v2/webhooks/custodialGelen custody webhook'ları; sağlayıcının kendi gizli anahtarıyla doğrulanır. Bkz. Custody Webhook'u Alma
POST /v2/webhooksYukarıdaki route'un kullanımdan kalkmış takma adı
/v2/mcp, /v2/mcp/**MCP etkin client'lar için Model Context Protocol aktarımı; integration servisi bunları bearer token olarak gönderilen client secret ile doğrular

İstek başlıkları​

BaşlıkZorunluAçıklama
AuthorizationKorumalı route'larBearer <access_token>
Content-TypeGövdeli isteklerapplication/json, dosya alan endpoint'lerde multipart/form-data
X-Correlation-IDHayırÇağrı için izleme kimliğiniz. Yoksa gateway bir tane üretir ve servise iletir; bir sorun bildirirken bu değeri paylaşın

Denetim kaydı​

Gateway, platformun denetim kaydı için her çağrıyı (metot, path, durum, süre, correlation id ve istek/yanıt gövdeleri) kaydeder.