الانتقال إلى المحتوى الرئيسي
POST
curl
تطلب endpoint «تحديث اتصال البنك» إجراء مزامنة الآن، وتُرجع 202 مع sync_id. أرسل "wait": true لانتظار مدة تصل إلى 25 ثانية والحصول على المزامنة المكتملة في استدعاء واحد، دون أي رسوم إضافية. يقيّد البنك الوصول دون إشراف، لذلك قد يُرجِع الاستدعاء 429 refresh_limit_reached مع Retry-After. راجع تحديث البيانات البنكية عند الطلب.

التفويضات

x-api-key
string
header
مطلوب

مفتاح API الخاص بتطبيقك، ويمكن الحصول عليه من Developers -> API keys في Business Console. يملك المفتاح الأساسي صلاحية وصول كاملة. يمكن تقييد المفتاح المسمّى: بلا صلاحية، أو قراءة، أو كتابة لكل مورد، ويمكن قصره على بعض سير العمل أو على الجلسات المعتمدة، وعلى قائمة من عناوين IP، وعلى تاريخ انتهاء. يعني الرمز 401 أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية. ويعني الرمز 403 أنه لم يُرسل أي مفتاح، أو أن المفتاح لا يملك صلاحية لهذا المورد أو الإجراء، أو أن الطلب صدر من عنوان خارج قائمة IP الخاصة به. ويعني الرمز 404 على مسار جلسة أن الجلسة خارج سير عمل المفتاح أو حالاته المسموح بها. يتلقى المفتاح الذي لا يملك وصولًا إلى الوسائط عناوين URL للصور والفيديو وملفات PDF بقيمة null، ويتلقى المفتاح الذي لا يملك صلاحية كتابة الجلسات روابط الجلسات والرموز بقيمة null. راجع https://docs.didit.me/console/api-keys.

الترويسات

Idempotency-Key
string

مفتاح اختياري لأمان إعادة المحاولة تختاره لعملية واحدة، بحد أقصى 255 حرفًا (يصلح UUID). الطلب المكرَّر بالمفتاح نفسه والـ endpoint والاستعلام والمحتوى يُجاب بالاستجابة الأولى نفسها، بالحالة والمحتوى نفسيهما، ولا يُنفَّذ ولا يُحتسب مرة ثانية. استخدام المفتاح نفسه مع endpoint أو استعلام أو محتوى مختلف يعيد 409 مع idempotency_key_reused، وبينما الطلب الأول ما زال قيد التنفيذ يعيد 409 مع idempotency_key_in_progress ومعه Retry-After. لا يُخزَّن الطلب الفاشل (أي 4xx أو 5xx)، لذا يمكنك إرساله مرة أخرى بالمفتاح نفسه. المفاتيح تخص تطبيقك، سواء استدعيت بمفتاح API أو بـ token الوصول. راجع إعادة المحاولة وidempotency.

Required string length: 1 - 255
Prefer
string

wait=<seconds> يُبقي الطلب معلقاً لمدة تصل إلى ذلك العدد من الثواني، بحد أقصى 25، مثل wait: true في نص الطلب.

مثال:

"wait=25"

معلمات المسار

id
string<uuid>
مطلوب

معرّف الاتصال.

الجسم

application/json

نص اختياري لطلب التحديث.

wait
boolean
افتراضي:false

true يُبقي الطلب معلقاً لمدة تصل إلى 25 ثانية ويُجيب بـ 200 مع المزامنة المكتملة، فيعيد الطلب الواحد بيانات حديثة. إذا لم يرد البنك خلال تلك المدة يُجيب الطلب بـ 202: اقرأ المزامنة باستخدام get_sync_run مع sync_id، أو اشترك في bank.sync.completed. يُرسل bank.data.updated فقط عندما تخزّن المزامنة تغييرات. يؤدي الرأس Prefer: wait=<seconds> (حتى 25) الوظيفة نفسها.

الاستجابة

انتهت المزامنة خلال 25 ثانية.

مزامنة مكتملة تعيدها عملية تحديث مع wait: تشغيل المزامنة مع outcome الخاص بها، وأعداد كل حساب في results وbalances_changed.

id
string<uuid>
مطلوب
connection_id
string<uuid>
مطلوب
trigger
enum<string>
مطلوب
الخيارات المتاحة:
initial,
scheduled,
requested
status
enum<string>
مطلوب
الخيارات المتاحة:
queued,
running,
succeeded,
partial,
failed
started_at
string<date-time> | null
مطلوب
finished_at
string<date-time> | null
مطلوب
results
object[]
مطلوب

ما الذي نفّذته عملية التشغيل، لكل حساب ومورد.

error
object | null
مطلوب

سبب فشل التشغيل ككل. القيمة null عندما لا يفشل. أخطاء الحسابات والموارد الفردية موجودة في results.

outcome
enum<string>
مطلوب

كيف انتهت المزامنة.

الخيارات المتاحة:
succeeded,
partial,
failed
balances_changed
boolean
مطلوب

هل تغيّر أي رصيد.

آخر تعديل في ٢٢ نوفمبر ٢٠٢٦