API referansı

Fidwyn'i kendi hatlarınızdan otomatikleştirin: sürümlenmiş bir REST API, uygulamadan uygulamaya kimlik bilgisi aracılığı, imzalı webhook'lar ve SCIM ile kullanıcı sağlama. Aşağıdaki biçimler temsili niteliktedir — yetkili, sürümlenmiş uç nokta referansı ürünle ve geliştirici portalıyla birlikte gelir.

1 · Bir token verin ¶

Her çağrı bir servis kimliği olarak yapılır. Entegrasyon için özel bir kullanıcı oluşturun ve onu, entegrasyonun tam olarak ihtiyaç duyduğu hakları — fazlasını değil — veren bir Access Group'a yerleştirin, ardından o kimliğe konsoldan role kapsamlı bir API token'ı verin. Token'ı bir sır gibi ele alın: kendi kasanızda saklayın ve aynı ekrandan rotasyona sokun veya iptal edin.

2 · Kimlik doğrulama ¶

API sürümlüdür, bu yüzden bir entegrasyon yükseltmede bozulmaz. Token'ı TLS üzerinden bir bearer kimlik bilgisi olarak gönderin:

Authorization: Bearer <api-token>
Accept: application/json

3 · Kimlik bilgisi aracılığı (A2A) ¶

Bir makine istemcisi, kapsamlı bir proxy belirteci alır; sır bir kez açığa çıkarılır ve her alım denetlenir. Bir istemci; isteğe bağlı bir kullanıcı belirteci, MFA, IP kısıtlaması ve bir onay kapısı ile sınırlandırılabilir. Temsili alışveriş:

# request a brokered secret (representative shape)
POST /api/v1/a2a/checkout
{ "client_id": "ci-deploy", "secret_ref": "win-build-01/svc-deploy" }

# response
{ "value": "<shown once>", "expires_in": 300, "audit_id": "a1b2c3" }

4 · Webhook'lara abone olma ¶

Webhook'lar HTTPS üzerinden iletilir ve bir HMAC sırrıyla imzalanır; olayları ve yeniden deneme sınırını yapılandırın ve eksiksiz bir teslim-ve-deneme günlüğünü inceleyin. Bir yükü güvenilir kabul etmeden önce imzayı doğrulayın:

X-Fidwyn-Signature: sha256=<hmac>
# body is the exact bytes signed; recompute and compare

5 · Kullanıcı sağlama (SCIM) ¶

Erişimin katılan-değişen-ayrılan yaşam döngüsünü otomatik olarak izlemesi için kullanıcıları ve grupları IdP'nizden sağlayın ve sağlamayı kaldırın. CI/CD hatları da çalışma anında tam-zamanında bir sır çekebilir; böylece bir depoda uzun ömürlü hiçbir kimlik bilgisi durmaz.