DATA API užklausos

API užklausų DATA CUBE su Postman pirmi žingsniai:

Paruošti aplinką (Environment)

1.1. Parsisiųsti ir suimportuoti Postman aplinką (JSON)

1.2. Pasirinkti aplinką (1) bei nustatyti aplinkos kintamųjų reikšmes (2,3) - user, password, database, server.

1.3. Paruošta aplinka:

2. Importuoti užklausų rinkinį (Collection) į Postman

3. Siųsti užklausas į DATA CUBE

3.1. Autentifikacija (authentification)

Pirmiausia reikia užmegzti ryšį su duomenų baze. Užklausos į Filemaker API reikalauja galiojančio žetono (token). Postman pagalba jį galima gauti išsiunčiant “authentification” užklausą importuotame rinkinyje.

3.1.1. Užklausos siuntimas

cURL užklausos kodas:

curl --location --request POST 'https://test.server.lt/fmi/data/v1/databases/DATA_CUBE_4_01/sessions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cG9ydGFsOnRlc3RpbmlzMTIz' \
--data-raw ''

3.1.2. Užklausos rezultatas

{
    "response": {
        "token": "ed77ab8161f546d4f1d47c793221430239254ec9a819ef13c86d"
    },
    "messages": [
        {
            "code": "0",
            "message": "OK"
        }
    ]
}

Gautame rezultate “code”: “0”, bei “message”: “OK” reiškia sėkmingą žetono sugeneravimą. Jis įrašomas į globalių kintamųjų reikšmes ir bus naudojamas tolimesnėse užklausose. Žetonas galioja 15 min nuo paskutinės jį naudojusios užklausos. Po to, reikia autentifikuotis iš naujo.

3.2. Visų įrašų vienoje lentelėje gavimas (Get all records)

Užmezgus ryšį tolimesnis galimas žingsnis yra išsitraukti visus duomenis iš nurodytos lentelės. Tai galima padaryti “get all records” užklausos pagalba.

Šiai užklausai reikalingas papildomas Layout kintamasis, kuris nurodo iš kurios DATA CUBE vietos imami duomenys. Kintamajam nustatyti pridėtas Pre-request Script kodas:

Šiuo metu (2020-08-17) į DATA CUBE įtrauktos 27 lentelės, kurios surašytos pateiktame sąraše:

const dataArray = [ "Skyriai", "Departamentai", "Rolė", "Poreikiai", "Procedūros", "Sutartys", "Iniciatoriai", 
"Preliminarios sutartys", "Teisės", "Tiekėjai", "Pirkimo būdai", "Pirkimai", "Ataskaita", 
"Pirkimo planai", "Pirkimo plano derinimai", "Pasiūlymai", "Pasiūlymų dalys", 
"Sutarties registravimo procedūros", "Patvirtinti pirkimų planai", "Patvirtinti pirkimų planų pirkimai", 
"Pretenzijos", "VPT Pirkimo būdai", "Procedūros dalys", "Pirkimų dalys", "Inicijavimo procedūros", 
"Inicijavimo procedūros derinimai", "Vertinimų subetapų pasiūlymų dalys", "BVPŽ kodai"];

Norimų duomenų lentelės pavadinimas įvedamas trečioje eilutėje, pvz.:

Įvykdžius užklausą gaunamas rezultatas - visi nurodytos lentelės duomenys JSON formatu, pvz.:

cURL užklausa:

4. Postman taip pat pateikia galimybę susigeneruoti užklausų kodą kitomis kalbomis:

Detali dokumentacija:

Statistikos modulis

DATA API užklausos

Analytics

Related content