المطورين

CredoRisk API الوثائق.

يطلب العميل تقريرًا من خلال API الخاص بك. تقوم الواجهة الخلفية بعد ذلك باستدعاء CredoRisk API، الذي يقوم بإنشاء التقرير الموحد وإرجاعه في JSON/PDF.

بداية سريعة
محطة مطوّر وتكامل API
التكامل

اربطوا CredoRisk بالخادم الخلفي في أيام قليلة

صُممت واجهة API للاستخدام من خادم إلى خادم: مصادقة بالمفتاح، ونقاط نهاية مستقرة، واستجابات JSON موحّدة. تحتفظ فرق الأعمال بنفس تنسيق CredoRisk كما في واجهة الويب — دون كشف مزوّدي المصادر للعميل النهائي.

  • مفاتيح API تُنشأ وتُلغى في مساحة العميل
  • التدفق الموصى به لفرنسا: search → france/{siren} → uuid → PDF
  • الدولي: البلد + المعرّف الرسمي
  • أخطاء موثّقة (401، 402، 422…) ومهل زمنية موصى بها
إنشاء حساب مطوّر

البداية السريعة - فرنسا (موصى به)

تدفق التقرير القياسي API: نفس منطق واجهة الويب CredoRisk. قم بتخزين uuid الذي تم إرجاعه.

# 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"

بالنسبة إلى SIRET المكون من 14 رقمًا، استخدم أول 9 أرقام كـ SIREN. المهلة الموصى بها: 60-90 ثانية.

التقرير القياسي API الكلاسيكية API (قديمة) API التسعير

المصادقة

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 التسعير

API مجاني. تعتمد الفواتير على التقارير التي تم إنشاؤها، مع تخفيضات كبيرة.

انظر تسعير التقرير

CredoRisk تنسيق التقرير

الاستجابة الموحدة: company، decision، sections.directors، sections.financials، sections.signals. عقد مستقر مستقل عن مزود المصدر.

التتبع الكامل

يتم تعقب جميع مكالمات API. يتم تخزين التقارير القياسية بواسطة uuid؛ يستخدم API الكلاسيكي report_id.

التدفق الموصى به

فرنسا - التقرير القياسي API

ابحث حسب الاسم، وأنشئ حسب SIREN، وخزن UUID، ثم اقرأ مرة أخرى وقم بتنزيل PDF.

1) البحث

GET /standard/search?q=... - اقرأ results.resultats[] وSIREN.

2) الجيل

GET /standard/france/{siren} - جلب report.uuid.

3) القراءة

GET /standard/report/{uuid} - الحقول credorisk + raw.

4) PDF

GET /standard/report/{uuid}/pdf - التنزيل بدون رصيد إضافي.

تقرير قياسي

نقاط النهاية /قياسي/*

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

بحث فرنسا عن طريق اسم الشركة. الرد: results.resultats (قائمة الشركات).

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

إنشاء أو إرجاع تقرير كامل عن فرنسا. الاستجابة: report.uuid، نسخة مخبأة.

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

إعادة القراءة باستخدام credorisk، raw، source_type.

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

التقرير الدولي (خارج فرنسا).

إرث

الكلاسيكية API (قديمة)

بالنسبة لفرنسا، تفضل التقرير القياسي API أعلاه.

POST /api/v1/companies/search

البحث عن الشركات حسب البلد + المعايير.

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

قم بإنشاء (أو إرجاع ذاكرة التخزين المؤقت) تقرير CredoRisk.

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

GET /api/v1/reports/{reportId}

استرداد التقرير المخزن حسب المعرف.

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

GET /api/v1/account/credits

قم بإرجاع الرصيد المتبقي والاستخدام الشهري API.

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

نموذج استجابة التقرير (تنسيق CredoRisk)

{ "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": [] } } }

رموز الخطأ الرئيسية

  • 401 — مفتاح API مفقود أو غير صالح
  • 402 — الاعتمادات غير كافية لإنشاء تقرير مباشر
  • 403 — لم يتم التحقق من الحساب
  • 404 — لم يتم العثور على التقرير
  • 422 — المعلمات غير صالحة
  • 429 — تم الوصول إلى حصة API الشهرية
  • 500 — خطأ داخلي
  • 503 — لم يتم تكوين خدمة البحث/البيانات

هل أنت مستعد لاختبار API؟

قم بإنشاء حساب، وإنشاء مفتاح CredoRisk API، ودمج إنشاء التقارير بسرعة في سير عمل العميل الخاص بك.

إنشاء حساب عرض التسعير
إنشاء حساب انظر التسعير API الوثائق