Деректерді жүктеп алу тәртібі

  • Бастапқы аутентификация

    Бастапқы аутентификация Аутентификация бөлімшесінде сипатталған.

    Бастапқы аутентификация үшін жүйеде бар пайдаланушының электрондық пошта мекенжайы мен құпиясөзі пайдаланылады. Ол үшін 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