إجراء استخراج البيانات

  • المصادقة الأولية

    يرد وصف المصادقة الأولية في القسم الفرعي المصادقة.

    تستخدم المصادقة الأولية البريد الإلكتروني وكلمة المرور لمستخدم موجود. ولإجراء ذلك، يلزم إرسال طلب POST، على سبيل المثال:

    bash
    curl -i --header "Content-Type: application/json" \
     --request POST \
     --data '{"email":"api-user@example.com","password":"Str0ngPas$"}' \
     https://api.vadsro.eu/api/v1/auth/sign_in

  • استخراج قائمة المستهلكين

    لاستخراج قائمة المستهلكين، يلزم إرسال طلب GET، على سبيل المثال:

    bash
    curl -i --header "access-token: *********************" \
 --header "token-type: Bearer" \
 --header "client: **********************" \
 --header "uid: api-user@example.com" \
 --request GET \
 --header "Content-Type: application/json" \
 --data '{"page":"2"}' \
 https://api.vadsro.eu/api/v1/customers

    تُستخرَج البيانات صفحةً صفحة ("total_pages": 8 — إجمالي عدد الصفحات، "current_page": 2 — الصفحة الحالية).

    ويجب تنظيم استخراج دوري للبيانات وفق رقم الصفحة:

    json
    {"data":[
       {
        "id":13,
        "name":"Example National Sports Federation",
        "subdivision_type_name":"Unit Owner",
        "inn":"1000000042",
        "contact_number":"+49-30-5550100"
},
... ],
  "total_pages":8,
  "current_page":2,
  "next_page":3
}

    ولاستخراج البيانات لاحقاً (استخراج أرشيفات القيم) سنحتاج إلى المعاملات التالية:

    • "id": 13 ("customer_id": "13") — المعرّف (المفتاح الفريد) للمستهلك في النظام.

  • استخراج قائمة وحدات القياس

    لاستخراج قائمة وحدات القياس، يلزم إرسال طلب GET، على سبيل المثال:

    bash
    curl -i --header "access-token: *********************" \
 --header "token-type: Bearer" \
 --header "client: **********************" \
 --header "uid: api-user@example.com" \
 --request GET \
 --header "Content-Type: application/json" \
 --data '{"page":"2"}' \
 https://api.vadsro.eu/api/v1/stations

    تُستخرَج البيانات صفحةً صفحة ("total_pages": 9 — إجمالي عدد الصفحات، "current_page": 2 — الصفحة الحالية).

    ويجب تنظيم استخراج دوري للبيانات وفق رقم الصفحة.

    json
    {"data":[
{
"id":18,
        "name":"Example Beverages Production GmbH",
        "equipment_type_id":1,
        "equipment_brand_name":"BK",
        "phone":"+49-30-5550101",
        "equipment_id":61,
        "customer_id":14
    }
... ],
  "total_pages":9,
  "current_page":2,
  "next_page":3
}

    ولاستخراج البيانات لاحقاً (استخراج أرشيفات القيم) نحتاج إلى المعاملات التالية:

    • "equipment_id": 61 — معرّف جهاز القياس.

    ولمواءمة البيانات (الأدلة المرجعية):

    • "customer_id": 14 — معرّف المستهلك؛
    • "equipment_type_id": 1 — معرّف نوع تكوين جهاز القياس.

  • استخراج خصائص الكائن

    لاستخراج خصائص وحدة قياس، يلزم إرسال طلب GET مع معرّف الوحدة في المسار، على سبيل المثال:

    bash
    curl -i --header "access-token: *********************" \
 --header "token-type: Bearer" \
 --header "client: **********************" \
 --header "uid: api-user@example.com" \
 --request GET \
 --header "Content-Type: application/json" \
 https://api.vadsro.eu/api/v1/stations/134/characteristics

    وid هو معرّف وحدة القياس الذي يُستلَم عند استخراج قائمة وحدات القياس.

  • استخراج أنواع أجهزة القياس

    لاستخراج أنواع أجهزة القياس، يلزم إرسال طلب GET، على سبيل المثال:

    bash
    curl -i  --header "access-token: *********************" \
 --header "token-type: Bearer" \
 --header "client: **********************" \
 --header "uid: api-user@example.com" \
 --request GET \
--header "Content-Type: application/json"  \
--data '{"page":"1"}' \
 https://api.vadsro.eu/api/v1/equipment_types

    ويجب تنظيم استخراج دوري للبيانات وفق المعاملات التالية:

    • page — رقم الصفحة.

  • استخراج القنوات

    لاستخراج القنوات مع ربطها بنوع جهاز القياس، يلزم إرسال طلب GET، على سبيل المثال:

    bash
    curl -i  --header "access-token: *********************" \
 --header "token-type: Bearer" \
 --header "client: **********************" \
 --header "uid: api-user@example.com" \
 --request GET \
--header "Content-Type: application/json"  \
--data '{"equipment_type_id": "2", "page":"1"}' \
 https://api.vadsro.eu/api/v1/channel_archive_types

    ويجب تنظيم استخراج دوري للبيانات وفق المعاملات التالية:

    • equipment_type_id — معرّف نوع تكوين الجهاز؛
    • page — رقم الصفحة.

  • استخراج رسائل الأجهزة

    لاستخراج دليل الرسائل (رموز الأحداث/الأخطاء) الخاص بنوع جهاز قياس، يلزم إرسال طلب GET، على سبيل المثال:

    bash
    curl -i --header "access-token: *********************" \
 --header "token-type: Bearer" \
 --header "client: **********************" \
 --header "uid: api-user@example.com" \
 --request GET \
 --header "Content-Type: application/json" \
 "https://api.vadsro.eu/api/v1/message_equipment_types?equipment_type_id=11&page=1"

    تُمرَّر معاملات التصفية في سلسلة الاستعلام:

    • equipment_type_id — معرّف نوع جهاز القياس؛
    • archive_type_id — معرّف نوع الأرشيف (اختياري، لتضييق نطاق الاختيار)؛
    • page — رقم الصفحة.

  • استخراج أرشيفات القراءات

    لاستخراج أرشيفات القراءات، يلزم إرسال طلب GET، على سبيل المثال:

    bash
    curl -i --header "access-token: *********************" \
 --header "token-type: Bearer" \
 --header "client: **********************" \
 --header "uid: api-user@example.com" \
 --request GET \
 --header "Content-Type: application/json" \
 --data '{"archive_type": "hourly", "equipment_id":"25",  "fp_end":"2021-02-20", "fp_start":"2021-02-01", "page":"1"}' \
 https://api.vadsro.eu/api/v1/channel_data

    ويجب تنظيم استخراج دوري للبيانات وفق المعاملات التالية:

    • equipment_id — معرّف جهاز القياس؛
    • archive_type — نوع الأرشيف (انظر الدليل المرجعي)؛
    • fp_start — بداية الفترة الزمنية؛
    • fp_end — نهاية الفترة الزمنية؛
    • page — رقم الصفحة.

  • استخراج الأرشيف لفترة زمنية

    لاستخراج الأرشيف لفترة زمنية، يلزم إرسال طلب GET، على سبيل المثال:

    bash
    curl -i --header "access-token: *********************" \
 --header "token-type: Bearer" \
 --header "client: **********************" \
 --header "uid: api-user@example.com" \
 --request GET \
 --header "Content-Type: application/json" \
 --data '{"archive_type": "hourly", "equipment_id":"25",  "fp_end":"2021-02-20", "fp_start":"2021-02-01", "page":"1", "channel_consolidation": "1"}' \
 https://api.vadsro.eu/api/v1/channel_data

    ويجب تنظيم استخراج دوري للبيانات وفق المعاملات التالية:

    • equipment_id — معرّف جهاز القياس؛
    • archive_type — نوع الأرشيف (انظر الدليل المرجعي)؛
    • fp_start — بداية الفترة الزمنية؛
    • fp_end — نهاية الفترة الزمنية؛
    • page — رقم الصفحة؛
    • channel_consolidation: 1 — معامل الاستخراج الموحَّد.

  • استخراج تكوين جهاز القياس

    لاستخراج تكوين جهاز القياس، يلزم إرسال طلب GET، على سبيل المثال:

    bash
    curl -i --header "access-token: *********************" \
 --header "token-type: Bearer" \
 --header "client: **********************" \
 --header "uid: api-user@example.com" \
 --request GET \
 --header "Content-Type: application/json" \
 --data '{"archive_type": "settings", "equipment_id":"25", "page":"1"}' \
 https://api.vadsro.eu/api/v1/channel_data

    ويجب تنظيم استخراج دوري للبيانات وفق المعاملات التالية:

    • equipment_id — معرّف جهاز القياس؛
    • archive_type = “settings”؛
    • page — رقم الصفحة.

  • استخراج تاريخ آخر جلسة اتصال

    لاستخراج تاريخ آخر جلسة اتصال لوحدة القياس، يلزم إرسال طلب GET، على سبيل المثال:

    bash
    curl -i --header "access-token: *********************" \
--header "token-type: Bearer" \
--header "client: **********************" \
 --header "uid: api-user@example.com" \
 --request GET  \
--header "Content-Type: application/json" \
--data '{ "id": "1816"}' https://api.vadsro.eu/api/v1/stations/last_seance_event_time

    ويجب تنظيم استخراج البيانات وفق المعامل:

    • id — معرّف وحدة القياس.

  • استخراج جلسات الاتصال

    لاستخراج جلسات اتصال وحدة القياس عن بُعد، يلزم إرسال طلب GET، على سبيل المثال:

    bash
    curl -i --header "access-token: *********************" \
 --header "token-type: Bearer" \
 --header "client: **********************" \
 --header "uid: api-user@example.com" \
 --request GET \
 --header "Content-Type: application/json" \
 "https://api.vadsro.eu/api/v1/seances?telemetry_id=85&fp_start=2021-11-02&fp_end=2021-11-30&page=1"

    ويجب تنظيم استخراج دوري للبيانات وفق المعاملات التالية:

    • telemetry_id — معرّف وحدة القياس عن بُعد؛
    • fp_start — بداية الفترة الزمنية؛
    • fp_end — نهاية الفترة الزمنية؛
    • page — رقم الصفحة.
آخر تحديث في

هل كانت هذه الصفحة مفيدة؟

اكتب للبحث في التوثيق

↑↓ للتنقل
Esc