Geliştiriciler

CredoRisk API belgeler.

Müşteri API numaranız aracılığıyla bir rapor talep ediyor. Daha sonra arka ucunuz, standartlaştırılmış raporu oluşturan ve onu JSON/PDF dosyasında döndüren CredoRisk API öğesini çağırır.

Hızlı başlangıç

Entegrasyon

CredoRisk’i backend’inize birkaç günde bağlayın

API, sunucudan sunucuya kullanım için tasarlanmıştır: anahtar kimlik doğrulama, kararlı endpoint’ler, normalize JSON yanıtları. İş ekipleri web arayüzündekiyle aynı CredoRisk formatını korur — kaynak sağlayıcıları son müşteriye göstermeden.

Müşteri alanında oluşturulan ve iptal edilebilen API anahtarları
Önerilen Fransa akışı: search → france/{siren} → uuid → PDF
Uluslararası: ülke + resmi kimlik
Belgelenmiş hatalar (401, 402, 422…) ve önerilen zaman aşımları

Geliştirici hesabı oluşturun

Hızlı Başlangıç — Fransa (önerilir)

Standart Rapor API akışı: CredoRisk web arayüzüyle aynı mantık. Döndürülen uuid dosyasını saklayın.

# 1) Search France by name (0 credit)
curl -sS -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/standard/search?q=airbus"
# -> read results.resultats[].siren

# 2) Generate France report (1 credit)
curl -sS -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/standard/france/383474814"
# -> store report.uuid

# 3) Full readback (0 credit)
curl -sS -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/standard/report/550e8400-e29b-41d4-a716-446655440000"

# 4) PDF (0 credit)
curl -sS -H "Authorization: Bearer <api_key>" \
  -o report.pdf \
  "https://credorisk.com/api/v1/standard/report/550e8400-e29b-41d4-a716-446655440000/pdf"
      

14 haneli SIRET için ilk 9 haneyi SIREN olarak kullanın. Önerilen zaman aşımı: 60-90 sn.

Standart Rapor API Klasik API (eski) API fiyatlandırma

Kimlik doğrulama

Each request is signed with a CredoRisk API key (header Authorization: Bearer or X-API-Key). The client never sees the source provider.

Authorization: Bearer <CREDORISK_API_KEY>
or
X-API-Key: <CREDORISK_API_KEY>
          

API fiyatlandırma

API ücretsizdir. Faturalandırma, toplu indirimlerle birlikte oluşturulan raporlara dayalıdır.

Rapor fiyatlandırmasına bakın

CredoRisk rapor biçimi

Standart yanıt: company, decision, sections.directors, sections.financials, sections.signals. Kaynak sağlayıcıdan bağımsız istikrarlı sözleşme.

Tam izlenebilirlik

Tüm API çağrılar izleniyor. Standart raporlar uuid tarafından saklanır; klasik API, report_id kullanır.

Önerilen akış

Fransa — Standart Rapor API

Ada göre arayın, SIREN ile oluşturun, UUID saklayın, tekrar okuyun ve PDF indirin.

1) Ara

GET /standard/search?q=... - results.resultats[] ve SIREN'yı okuyun.

2) Nesil

GET /standard/france/{siren} - report.uuid'yi getir.

3) Tekrar

GET /standard/report/{uuid} - alanlar credorisk + raw.

4) PDF

GET /standard/report/{uuid}/pdf - ekstra kredi olmadan indirin.

Standart rapor

Uç noktalar /standart/*

GET /api/v1/standard/search?q=...

Fransa'yı şirket adına göre arayın. Yanıt: results.resultats (şirket listesi).

GET /api/v1/standard/france/{siren}

Tam bir Fransa raporu oluşturun veya döndürün. Yanıt: report.uuid, cached.

GET /api/v1/standard/report/{uuid}

credorisk, raw, source_type ile tekrar okuma.

GET /api/v1/standard/{country}/{identifier}

Uluslararası rapor (Fransa dışında).

Miras

Klasik API (eski)

Fransa için yukarıdaki API Standart Raporu'nu tercih edin.

POST /api/v1/companies/search

Şirketleri ülkeye + kriterlere göre arayın.

curl -X POST -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{"countries":"FR","name":"LA REDOUTE","city":"ROUBAIX"}' \
  "https://credorisk.com/api/v1/companies/search"

GET /api/v1/companies/{providerCompanyId}/report

Bir CredoRisk raporu oluşturun (veya önbelleği döndürün).

curl -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/companies/FR30612897/report?country=FR&language=en"

GET /api/v1/reports/{reportId}

Tanımlayıcıya göre saklanan bir raporu alın.

curl -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/reports/1284"

GET /api/v1/account/credits

Kalan bakiyeyi ve aylık API kullanımı iade edin.

curl -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/account/credits"

Örnek rapor yanıtı (CredoRisk biçimi)

{
  "report_id": 1284,
  "credits_cost": 1,
  "source": "live",
  "report": {
    "company": {
      "name": "EXEMPLE SA",
      "country": "FR",
      "status": "Active",
      "reg_no": "123456789",
      "vat_no": "FR00123456789",
      "address": {
        "street": "10 RUE EXEMPLE",
        "city": "PARIS",
        "postcode": "75001",
        "region": "ILE-DE-FRANCE"
      }
    },
    "decision": {
      "score": 72,
      "risk_band": "B",
      "credit_limit": {
        "value": 50000,
        "currency": "EUR"
      },
      "days_beyond_terms": 8
    },
    "sections": {
      "directors": [],
      "financials": [],
      "signals": []
    }
  }
}
      

Ana hata kodları

401 — Eksik veya geçersiz API anahtarı
402 — Canlı rapor oluşturmak için yeterli kredi yok
403 — Hesap doğrulanmadı
404 — Rapor bulunamadı
422 — Geçersiz parametreler
429 — Aylık API kotaya ulaşıldı
500 — Dahili hata
503 — Arama/veri hizmeti yapılandırılmadı

API'yi test etmeye hazır mısınız?

Bir hesap oluşturun, bir CredoRisk API anahtarı oluşturun ve rapor oluşturmayı müşteri iş akışınıza hızla entegre edin.

Hesap oluşturmak Fiyatlandırmayı görüntüle