توثيق API, ComplianceEvidenceGapPack

واجهة API غير متزامنة: حزمة فجوات أدلة الامتثال

حمّل سياسة أو إجراء أو مستند رقابة لإعداد الأدلة ومصفوفة المتطلبات والفجوات وخطة الأدلة.

نقطة النهاية: POST https://mxprocess.com/api/files/start-process
المصادقة: Bearer JWT POST /api/login_check
التكلفة: 120

بدء الإجراء

curl --location --request POST 'https://mxprocess.com/api/files/start-process' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--form 'file=@"/path/to/policy.pdf"' \
--form 'actionName="ComplianceEvidenceGapPack"' \
--form 'parameters=[["language",["English"]],["framework",["ISO 27001 control context"]],["organizationContext",["SaaS company"]]]' \
--form 'async=true'

تحقق من الصيغ المقبولة وتابع المعالجة ونزّل النتائج.

الاستجابة الأولية والاستطلاع

{"id":123,"action":{"actionName":"ComplianceEvidenceGapPack","slug":"ai-compliance-evidence-gap-pack"},"accomplished":false,"trackingUrl":"https://mxprocess.com/api/actions/get-action-infos/123"}

استعلم عن عنوان التتبع باستخدام JWT نفسه. عند الاكتمال، يحتوي actionResults على TXT المصدر وملخص Markdown والمتطلبات والفجوات وملفات CSV للمهام، بالإضافة إلى JSON. نزّل كل ملف، بما في ذلك JSON، عبر /api/actions/download-action-result/123/FILENAME.

مثال على خطأ وظيفي

{"error":"ERROR_CEG004 Compliance Evidence Gap Pack accepts PDF, PNG, JPG and TIFF files only."}

تحقق من الصيغ المقبولة وتابع المعالجة ونزّل النتائج. واجهة API متزامنة.

اتصل بنا