Watsy
توثيق الـ APIمقدمة

توثيق الـ API

مقدمة

العنوان الأساسي، المصادقة، وشكل الطلبات والردود في Watsy API v1.

Watsy API واجهة REST بسيطة: ترسل رمز التحقق بطلب، وتفحص ما كتبه المستخدم بطلب ثانٍ. نحن نولّد الرمز ونختار القناة ونتابع التسليم والفوترة.

العنوان الأساسي

Base URL
https://watsy.me/v1
  • الطلب والرد بصيغة JSON. أرسل Content-Type: application/json مع أي جسم. الحد الأقصى للجسم 16KB.
  • الحقول بصيغة snake_case. أي حقل غير معروف يرجع 400 validation_failed.
  • المبالغ بالدينار العراقي. الحقول المنتهية بـ _milli أعداد صحيحة بالـ milli-IQD (1 دينار = 1000).
  • الأوقات بصيغة ISO 8601 وبتوقيت UTC.
  • الردود لا تُخزَّن مؤقتاً (Cache-Control: no-store).

المصادقة

كل طلب يحتاج مفتاح المشروع في ترويسة Authorization. تنشئ المفاتيح من لوحة المشروع ← مفاتيح API، والمفتاح يظهر مرة واحدة عند إنشائه.

Header
Authorization: Bearer wsy_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
النوعالبادئةالسلوك
حقيقيwsy_live_يرسل فعلاً ويخصم من الرصيد
اختبارwsy_test_لا يرسل ولا يخصم، ويعمل مع أرقام الاختبار فقط. انظر مفاتيح الاختبار

الـ API مخصص للاستدعاء من الخادم فقط، ولا يدعم CORS. لا تضع المفتاح داخل تطبيق موبايل أو صفحة ويب أو مستودع عام. المفتاح المفقود أو الملغى يرجع 401 unauthenticated.

معرّف الطلب

كل رد يحمل الترويسة X-Request-Id. اذكرها عند التواصل مع الدعم. يمكنك إرسال X-Request-Id خاص بك (8 إلى 64 حرفاً من A-Z a-z 0-9 . _ : -) وسنعيده كما هو، وإلا نولّد واحداً مثل req_….

النقاط المتاحة

الطريقةالمسارالوظيفة
POST/v1/verifyإنشاء عملية تحقق وإرسال الرمز
POST/v1/verify/{id}/checkفحص الرمز
GET/v1/verify/{id}حالة عملية التحقق
POST/v1/verify/{id}/cancelإلغاء عملية تحقق
GET/v1/messagesسجل الرسائل
GET/v1/balanceالرصيد