رویهٔ دریافت داده‌ها

  • احراز هویت اولیه

    احراز هویت اولیه در زیربخش احراز هویت شرح داده شده است.

    برای احراز هویت اولیه از ایمیل و گذرواژهٔ یک کاربر موجود استفاده می‌شود. برای این کار باید یک درخواست 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") — شناسه (کلید یکتا) مصرف‌کننده در سامانه.
  • دریافت فهرست گره‌های اندازه‌گیری

    برای دریافت فهرست گره‌های اندازه‌گیری (metering unit) باید یک درخواست 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 — شمارهٔ صفحه.
آخرین به‌روزرسانی در

آیا این صفحه مفید بود؟