Dokumentace API

Rozhraní pro čtení firem (sídel i provozoven) pro systémovou integraci: celý seznam firem po dávkách a detail firem podle ID.

• Adresa https://www.tsmotest.api.protank.bclogia.cz/api/v1
• Přihlášení OAuth2 client credentials
• Formát JSON, názvy v snake_case

Jak začít

1. Získejte přístupový token

   Identity server vydá token na základě ClientID a ClientSecret. Parametr company je název vaší firmy. Token platí omezenou dobu; po vypršení si vyžádejte nový.

   Kopírovat

   curl -X POST https://identity.bclogia.cz/connect/token \
     -d grant_type=client_credentials \
     -d client_id={ClientID} \
     -d client_secret={ClientSecret} \
     -d scope=protank \
     -d company={CompanyName}

2. Načtěte první dávku firem

   Token pošlete v hlavičce Authorization. První dávku vyžádejte s prázdným last_rv; velikost dávky je 1 až 100. Odpověď obsahuje count (kolik firem zbývá včetně této dávky) a items (firmy v dávce).

   Kopírovat

   curl -X POST https://www.tsmotest.api.protank.bclogia.cz/api/v1/company/list \
     -H "Authorization: Bearer {token}" \
     -H "Content-Type: application/json" \
     -d '{"last_rv": null, "batch_size": 100}'

3. Pokračujte další dávkou

   Do last_rv pošlete row_version poslední firmy z předchozí odpovědi. Prázdné items znamenají, že další firmy už nejsou; stejným voláním s posledním row_version později načtete jen firmy, které od té doby přibyly nebo se upravily.

   Kopírovat

   curl -X POST https://www.tsmotest.api.protank.bclogia.cz/api/v1/company/list \
     -H "Authorization: Bearer {token}" \
     -H "Content-Type: application/json" \
     -d '{"last_rv": "AAAAAAAB9xQ=", "batch_size": 100}'

   Detail konkrétních firem načtete podle ID (nejvýše 100 najednou):

   Kopírovat

   curl -X POST https://www.tsmotest.api.protank.bclogia.cz/api/v1/company/read_batch \
     -H "Authorization: Bearer {token}" \
     -H "Content-Type: application/json" \
     -d '{"ids": [49631, 49630]}'

Přehled metod