خطوات البدء

التبويبات العمودية

دليل البدء السريع
دليل البدء السريع

تم تصميم هذا الدليل لمساعدتك في فهم واجهات واثق البرمجية (API). ستجد هنا كل ما تحتاجه للبدء بالاستخدام. ابتداءً من التسجيل مروراً بإضافة التطبيق وتصحفح المستندات وحتى ارسال استعلامك الأول.

الخطوة 1: إنشاء حساب
الخطوة 1: إنشاء حساب

قم بإنشاء حساب مطور عبرالبوابة. بمجرد التحقق من عنوان بريدك الإلكتروني ، ستتمكن من تطوير تطبيقك الأول.

الخطوة 2: إضافة تطبيق
الخطوة 2: إضافة تطبيق

قم بتسجيل الدخول لإضافة تطبيقك الاول. ستتمكن من اضافة تطبيق واحد فقط للباقة المجانية. 

  1. تسجيل الدخول إلى"بوابة المطور"
  2. انتقل إلى قسم "تطبيقاتي"
  3. انقر فوق الزر "إضافة تطبيق جديد"
  4. قم بإنشاء اسم تطبيق من اختيارك (مثل "My Test App")
  5. حدد المنتجات التي تحتاجها
  6. حدد "إضافة تطبيق" لإكمال تسجيل التطبيق الخاص بك

يمكن الآن الوصول إلى تطبيقاتك من خلال صفحة تطبيقاتي.

الخطوة 3: الحصول على مفتاح الأمان لتطبيقك
الخطوة 3: الحصول على مفتاح الأمان لتطبيقك

بعد اضافة تطبيقك الاول. ستتمكن من استعراض التطبيق عبر النقر على استعراض. الان تستطيع الحصول على مفتاح الآمان الخاص بهذا التطبيق.

  • يرجى الابقاء على مفتاح الآمان و كلمة السر الخاص بتطبيقك في مكان آمن دوماً.

الخطوة 4: إرسال استعلامك الأول
الخطوة 4: إرسال استعلامك الأول

أنت الان جاهز لتنفيذ استعلامك الأول.

بإمكانك الان تصفح مستندات المطورين الخاصة بكل منتج على حده. بناء على الباقة المتاحة لك ستتمكن من استخدام الخدمات المصرح لك استخدامها. التالي مثال على احد الخيارات المتاحة لكيفية تنفيذ استعلامك الاول 

curl -X GET "https://api.wathq.sa/v4/commercialregistration/info/1010XXXXXX" \
-H "accept: application/json" \
-H "apiKey: YOURAPIKEY

1010XXXXXX - تمثل رقم السجل التجاري او رقم الكيان المبتدأ ب 7 المراد الاستعلام عنه.

YOURAPIKEY - تمثل مفتاح الأمان الخاص بتطبيقك

 

العينة التالية تمثل الرد على الاستعلام السابق في حال نجاح الاستعلام http status = 200

{
  "cr_info": {
    "cr_name": "اسم السجل التجاري",
    "cr_number": 1010XXXXXX,
    "cr_entity_no": 7015XXXXXX,
    "cr_issue_date": "1440/10/29",
    "cr_expiry_date": "1441/10/29",
    "cr_main_number": null,
    "cr_bus_type": {
      "id": "101",
      "name": "مؤســـسة فـــردية"
    },
    "cr_fiscal": {
      "month": 10,
      "day": 28,
      "calendar_type": {
        "id": 1,
        "calendar_type": "هجري"
      }
    },
    "cr_status": {
      "id": "active",
      "name": "السجل التجاري قائم",
      "name_en": "السجل التجاري قائم"
    },
    "cr_cancellation": null,
    "cr_location": {
      "id": "1010",
      "name": " الرياض"
    },
    "cr_company": null,
    "cr_activities": {
      "description": "أعمال ورش النجارة بشكل عام،صناعة المباني الخشبية سابقة التجهيز،أنشطة أخرى خاصة بانتاج وصناعة منتجات النجارة المستخدمة في البناء والتشييد",
      "isic": [
        {
          "id": "162250",
          "name": "أعمال ورش النجارة بشكل عام",
          "name_en": "Carpentry works"
        },
        {
          "id": "162270",
          "name": "صناعة المباني الخشبية سابقة التجهيز",
          "name_en": "Manufacture of prefabricated wooden buildings"
        },
        {
          "id": "162290",
          "name": "أنشطة أخرى خاصة بانتاج وصناعة منتجات النجارة المستخدمة في البناء والتشييد",
          "name_en": "Other activities of production and manufacture of carpentry products used in construction"
        }
      ]
    }
  }
}

 

جميع الاستعلامات سواء الناجحة او الفاشلة  سيتم ارجاع رقم مرجعي خاص بها لغرض استخدامه عند وجود اي استفسار مع فريق دعم واثق. بالامكان الحصول على الرقم المرجعي من الرد المستلم من الخدمة Response header . تستطيع دوماً الحصول على الرقم المرجعي المسمى ب THIQAH-API-ApiMsgRef كما في العينة التالية.

THIQAH-API-ApiMsgRef →6c7d7d44-b1f8-4b1a-8db1-4dbca3370f57