Birlesa bir B2B platformudur: resmî kayıtlardan oluşturulan firma sayfaları, tedarikçilerle eşleştirilen alıcı ihtiyaçları, teklifler, anlaşmalar ve güvenli ödeme hesabında tutulan ödemeler. Bu sayfalar, yazılımınızın Birlesa ile nasıl çalıştığını anlatır.
| Ne yapmak istiyorsunuz | Ne kullanılır |
|---|---|
| Herkese açık verileri okumak: firmalar, fırsatlar, aylık endeks, ihracat gereklilikleri | REST API; anahtarsız ya da daha yüksek bir istek limiti için anahtarla |
| Kuruluşunuz adına işlem yapmak: ihtiyaç yayımlamak, tedarikçilerden teklif istemek | REST API ya da MCP sunucusu; bu izne sahip bir API anahtarıyla |
| Kuruluşunuzla ilgili bir şey olduğunda haberdar olmak | Webhook'lar |
| Bir webhook'un bildirdiği kayıtları okumak (ihtiyaçlar, anlaşmalar, teklifler, güvenli ödemeler, sevkiyatlar) | org:read izinli bir anahtarla /v1/org/... |
| Bir yapay zekâ asistanına Birlesa'nın araçlarını vermek | /mcp adresindeki MCP sunucusu |
| Toplulaştırılmış piyasa verilerini sözleşmeyle kullanmak (bankalar, birlikler, kamu kurumları) | Veri ürünleri |
Temel adres ve biçimler
- Canlı ortam:
https://api.birlesa.com. Deneme ortamı (sandbox) erişimi henüz sunulmuyor (deneme ortamı). - İstekler ve yanıtlar JSON'dur (UTF-8). Zamanlar UTC'de, RFC 3339 biçimindedir. Para tutarları ondalık sayı dizgileridir (
"1250.00"), asla kayan noktalı sayı değildir. Ülkeler ISO 3166-1 alpha-2 kodlarıyla yazılır (TR,SA); bir alanın açıklaması belirttiğindeEUveGCCblokları gösterir. - API'nin eksiksiz tanımı OpenAPI belgesidir: birlesa.com/openapi.json(yeni sekmede açılır). Her işlem, alan ve hata kodu orada listelenir.
Sayfalar
- Kimlik doğrulama: API anahtarları, OAuth istemci kimlik bilgileri, izinler.
- Sınırlar ve kotalar: hız sınırları, günlük kotalar, kullanım.
- Hatalar: sorun belgesi biçimi ve karşılaşacağınız kodlar.
- Webhook'lar: uç noktalar, imzalar, yeniden denemeler. Olay kataloğu her olayı listeler.
- Sürümleme ve kullanımdan kaldırma:
/v1içinde neyin değişebileceği ve kaldırmaların nasıl duyurulduğu. - MCP sunucusu: yapay zekâ asistanları için araçlar.
- Deneme ortamı: sahte iş ortaklarına ve test verilerine karşı geliştirme (henüz sunulmuyor).
- Hizmet düzeyleri: neyi hedeflediğimiz ve tutturamadığımızda size nasıl haber verdiğimiz.
- Veri ürünleri: sözleşmeyle sunulan, toplulaştırılmış veri setleri.
Temel kurallar
- Gizli bilgileri (API anahtarları, istemci gizli anahtarları, webhook gizli anahtarları) kendi sunucularınızda tutun. Yalnızca bir kez gösterilirler; biz yalnızca özetlerini (hash) ya da mühürlü bir kopyalarını saklarız ve yeniden gösteremeyiz. Biri sızarsa iptal edin ve yenisini oluşturun.
- Kişisel veriler tasarım gereği API'nin dışında kalır. Webhook'lar metin ya da ad değil, kimlik (id) taşır. Görüşme mesajlarını anahtarlar değil, paneldeki kişiler okur.
- Bir entegrasyonun yaptığı her şey, anahtarı ya da istemcisiyle birlikte kuruluşunuzun denetim kaydına işlenir.