BoxLatviaIzstrādātājiem
LVEN
Pieprasīt piekļuvi
API atsauce

API atsauce

Bāzes URL: https://api.boxlatvia.lv. Visi ceļi zemāk sākas ar /v1. Pieprasījumi un atbildes ir JSON, izņemot attēlu augšupielādi (multipart) un token pieprasījumu (forma).

#Jomas

LokācijasVietas, kur atrodas jūsu telpas: adrese, rajons, atrašanās vieta kartē un ērtības.6 galapunkti →TelpasNoliktavas telpas ar cenām, izmēriem un pieejamību. Kad tās ir gatavas, iesniedziet izskatīšanai.8 galapunkti →AttēliAugšupielādējiet un pārvaldiet savu telpu un lokāciju attēlus.3 galapunkti →Atsauces datiĒrtību, rajonu, cenas mērvienību un izmēru kodi, ko lieto jūsu pieprasījumi.5 saraksti →Piegādātāja profilsLasiet un atjauniniet sava uzņēmuma datus un pārbaudiet, kurus piekļuves datus lietojat.3 galapunkti →

#Visi galapunkti

GalapunktsTiesībasKo tas dara
GET/v1/locationslocations:readLokāciju saraksts — Jūsu lokācijas, vecākās pirmās, pa vienai lapai.
POST/v1/locationslocations:writeIzveidot lokāciju — Izveido lokāciju. Obligāts ir tikai name: pārējo varat aizpildīt pakāpeniski; missing parāda, kas vēl atlicis.
GET/v1/locations/{id}locations:readIegūt lokāciju — Viena lokācija. Atbildē ir ETag, kas vajadzīgs, lai to mainītu vai dzēstu.
PATCH/v1/locations/{id}locations:writeAtjaunināt lokāciju — Maina tikai tos laukus, ko nosūtāt. external_id var iestatīt vienu reizi, pēc tam tas nemainās.
PUT/v1/locations/by-external-id/{external_id}locations:writeIzveidot vai atjaunināt pēc jūsu identifikatora — Izveido lokāciju, ja jūsu identifikators ir jauns, citādi atjaunina nosūtītos laukus. If-Match nav vajadzīgs: paredzēts datu plūsmām, kurām jābūt noteicošām.
DELETE/v1/locations/{id}locations:writeDzēst lokāciju — Dzēš lokāciju un tās attēlus. Tiek atteikts, kamēr lokācijā vēl ir telpas.
GET/v1/boxesboxes:readTelpu saraksts — Jūsu telpas, vecākās pirmās, pa vienai lapai.
POST/v1/boxesboxes:writeIzveidot telpu — Izveido telpu kā DRAFT (melnrakstu). Vajadzīgs name un lokācija; pārējo varat pievienot vēlāk.
GET/v1/boxes/{id}boxes:readIegūt telpu — Viena telpa ar ETag, kas vajadzīgs, lai to mainītu vai dzēstu.
PATCH/v1/boxes/{id}boxes:writeAtjaunināt telpu — Maina tikai tos laukus, ko nosūtāt, tostarp pieejamo telpu skaitu (available_units) un cenas. Izmaiņas publicētā telpā mājaslapā redzamas uzreiz.
PUT/v1/boxes/by-external-id/{external_id}boxes:writeIzveidot vai atjaunināt pēc jūsu identifikatora — Izveido telpu, ja jūsu identifikators ir jauns (tad obligāti name un lokācija), citādi atjaunina nosūtītos laukus. Bez If-Match: ideāli piemērots pieejamības un cenu datu plūsmām.
POST/v1/boxes/{id}/submitboxes:writeIesniegt izskatīšanai — Lūdz BoxLatvia izskatīt un publicēt telpu (DRAFT → REVIEW). API nekad nepublicē: to dara BoxLatvia darbinieki.
POST/v1/boxes/{id}/withdrawboxes:writeAtsaukt — Izņem telpu no izskatīšanas vai no mājaslapas un atgriež statusā DRAFT. Melnraksts paliek melnraksts (200).
DELETE/v1/boxes/{id}boxes:writeDzēst telpu — Dzēš telpu un tās attēlus. Telpu, kurai ir pasūtījumi, dzēst nevar: iestatiet available_units uz 0, lai apturētu jaunas rezervācijas.
GET/v1/boxes/{id}/imagesboxes:readAttēlu saraksts — Telpas attēli, vecākie pirmie.
POST/v1/boxes/{id}/imagesimages:writeAugšupielādēt attēlus — Augšupielādē līdz 5 attēliem vienlaikus kā multipart/form-data, katram attēlam viena daļa ar nosaukumu file.
DELETE/v1/boxes/{id}/images/{image_id}images:writeDzēst attēlu — Dzēš attēlu un tā failu. Dzēšot telpu vai lokāciju, tiek izdzēsti arī tās attēli.
GET/v1/reference/{kind}reference:readAtsauces datu saraksts — Kodi, ko lietojat citos pieprasījumos. Katrai rindai ir stabils code: lietojiet to, nevis latvisko nosaukumu vai identifikatoru. Saraksti ir īsi un mainās reti: iegūstiet tos ne biežāk kā reizi dienā.
GET/v1/mesupplier:readKas es esmu — Piekļuves dati, ar kuriem izsaucat API, to tiesības un jūsu piegādātāja profils. Pirmais izsaukums, lai pārbaudītu, vai viss darbojas.
GET/v1/suppliersupplier:readIegūt savu profilu — Jūsu uzņēmuma ieraksts ar ETag, kas vajadzīgs tā mainīšanai.
PATCH/v1/suppliersupplier:writeAtjaunināt savu profilu — Maina kontaktinformācijas un adreses laukus. Reģistrācijas numuru, personas tipu un visu komerciālo pārvalda BoxLatvia, un to šeit mainīt nevar.
POST/v1/oauth/tokentiesības nav vajadzīgasIegūt piekļuves token — OAuth 2.0 client credentials: apmainiet savu client id un noslēpumu pret bearer token, kas derīgs 15 minūtes.

#Servisa galapunkti

Šiem piekļuves dati nav vajadzīgi.

GalapunktsKo tas dara
GET/v1/healthDarbības pārbaude. Atgriež {"status":"ok"}. Piekļuves dati nav vajadzīgi.
GET/v1/openapi.jsonŠis API kā OpenAPI 3.1 dokuments koda ģeneratoriem un rīkiem, piemēram, Postman. Piekļuves dati nav vajadzīgi.
GET/v1/.well-known/jwks.jsonPubliskās atslēgas, ar kurām tiek parakstīti piekļuves tokeni. Piekļuves dati nav vajadzīgi.

#Vienošanās