API: Şablon Kullanım Bilgisi & Keşfedilebilirlik
Bir şablonu external API ile kullanmadan önce hangi tarafları, hangi değişkenleri kabul ettiğini görmek için yeni endpoint. Sessiz başarısızlıklara son.
Dashboard’da hazırladığınız bir şablonu API’den kullanmak isterseniz, hangi tarafları kabul ettiğini, hangi değişkenleri beklediğini, hangi alan tipinde olduğunu öğrenmeniz gerekir. Önceden bunu görmek için Postman üzerinde deneme-yanılma yapıyordunuz — bir hatırlatma denemesi attığınızda 404, INVALID_PARTY veya boş alan dönüyordu, sebebini anlayamıyordunuz.
Yeni: GET /api/v1/templates/:id/usage
Tek istekte şablonun API sözleşmesini dökümante ediyor:
GET /api/v1/templates/907f6f26-.../usage
X-API-Key: imz_...
Yanıt:
{
"template_id": "907f6f26-...",
"template_name": "Kira Sözleşmesi",
"parties": [
{
"id": "kiraya-veren",
"name": "Kiraya Veren",
"role": "OWNER",
"required_fields": ["full_name", "email", "phone", "government_id"]
},
{
"id": "kiraci",
"name": "Kiracı",
"role": "SIGNER",
"required_fields": ["full_name", "email", "phone", "government_id"]
}
],
"variables": [
{
"slug": "full_name",
"type": "dynamic_text",
"scope": "per-party",
"template_party_id": "kiraya-veren"
},
{
"slug": "monthly_rent",
"type": "dynamic_text",
"scope": "global"
},
...
],
"example": {
"curl": "curl -X POST ...",
"json": { ... }
}
}
Sessiz Başarısızlık Düzeltildi
POST /api/v1/demands çağrısında gönderdiğiniz bir değişken slug’ı şablonda yoksa, eskiden sessizce atlanırdı — sözleşme oluşurdu ama o alan boş kalırdı. Yeni davranış: yanıtta iki ek alan gelir:
{
"demand_id": "...",
"signing_url": "...",
"variables_applied": ["full_name", "monthly_rent", "..."],
"variables_ignored": ["fooo_bar"]
}
variables_ignored boş değilse, slug’ınızı kontrol edin — yazım hatası olabilir.
Alan Türleri
Variables filtresi artık şu tipleri tanır:
dynamic_text— serbest metincells— bölmeli (TC kimlik gibi 11 hane)date— tarihdropdown— açılır liste
Önceden sadece dynamic_text desteklenmişti — cells/date/dropdown slug’ları sessizce atlanırdı. Bu da düzeltildi.
Dashboard’da Görünür
/sablonlar/:id sayfasında yeni “API Kullanımı” sekmesi eklendi: cURL örneği, JSON payload, ve değişken kataloğu görsel olarak listeleniyor. Geliştiricinize doğrudan bu sayfayı gönderebilirsiniz.
Konuyla İlgili