URBANETAURBANETA
URBANETAURBANETA

Valoda

Tēma

Developer Docs

REST API dokumentācija

Veidojiet integrācijas ar Urbaneta. Automatizējiet rēķinu izrakstīšanu, sinhronizējiet iedzīvotājus, nolasiet skaitītāju datus un vēl vairāk.

API atslēgas

Ģenerējiet API atslēgas konta iestatījumos. Katra atslēga ir piesaistīta jūsu organizācijai.

Bearer autorizācija

Visiem pieprasījumiem nepieciešams derīgs Bearer tokens. Tokeni beidzas pēc 15 minūtēm — izmantojiet refresh tokenus automātiskai atjaunošanai.

Tīmekļa āķi

Abonējiet notikumus (invoice.created, payment.received, reading.submitted) ar HMAC parakstītiem datiem.

Pamata URL
https://testlnp.workizon.com/api

Visi pieprasījumi jāveic pa HTTPS. Aizstājiet ar sava servera URL, ja nepieciešams.

Autentifikācija

Iekļaujiet piekļuves tokenu Authorization galvenē katrā pieprasījumā.

# Tokeni ir īslaicīgi. Izmantojiet POST /auth/refresh ar refresh tokenu, lai automātiski iegūtu jaunu piekļuves tokenu. Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Ātrā sākšana

Trīs soļi līdz pirmajai API integrācijai.

1. Autentificējieties un iegūstiet tokenu

curl -X POST https://testlnp.workizon.com/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","password":"yourpassword"}'

# Response
{ "data": { "accessToken": "eyJ...", "refreshToken": "dGhp..." } }

2. Iegūstiet savu ēku sarakstu

curl https://testlnp.workizon.com/api/buildings \
  -H "Authorization: Bearer $ACCESS_TOKEN"

3. Ģenerējiet rēķinus ēkai

curl -X POST https://testlnp.workizon.com/api/invoices/generate-bulk \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"buildingId":"<uuid>","periodStart":"2025-01-01","periodEnd":"2025-01-31"}'

JavaScript / TypeScript piemērs

SDK nav nepieciešams — API izmanto standarta REST. Piemērs rēķinu iegūšanai un maksājuma reģistrēšanai.

# Fetch unpaid invoices
curl "https://testlnp.workizon.com/api/invoices?buildingId=<uuid>&status=sent" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

# Mark invoice as paid
curl -X PATCH "https://testlnp.workizon.com/api/invoices/<invoice-id>" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"paid","paidDate":"2025-02-01"}'

Galapunktu uzziņa

Autentifikācija

POST/auth/loginPieteikties ar e-pastu un paroli, atgriež piekļuves un atjaunošanas tokenus
POST/auth/refreshAtjaunot beigušos piekļuves tokenu ar atjaunošanas tokenu
POST/auth/logoutBeigt pašreizējo sesiju
POST/auth/magic-linkPieprasīt magic-saites pieteikšanās e-pastu

Ēkas

GET/buildingsVisu autorizētā īrnieka ēku saraksts
POST/buildingsIzveidot jaunu ēku
GET/buildings/:idIegūt ēku pēc ID
PATCH/buildings/:idAtjaunot ēkas iestatījumus (nosaukums, adrese, norēķini u.c.)
DELETE/buildings/:idDzēst ēku (nepieciešams paroles apstiprinājums)

Dzīvokļi

GET/buildings/:id/apartmentsDzīvokļu saraksts ēkā
POST/buildings/:id/apartmentsIzveidot dzīvokli
PATCH/buildings/:id/apartments/:aptIdAtjaunot dzīvokļa datus
DELETE/buildings/:id/apartments/:aptIdDzēst dzīvokli

Rēķini

GET/invoicesRēķinu saraksts ar filtrēšanu (statuss, ēka, datumu diapazons)
GET/invoices/:idIegūt rēķina detaļas, ieskaitot pozīcijas
POST/invoices/generate-bulkĢenerēt rēķinus ēkai un periodam
PATCH/invoices/:idAtjaunot rēķina statusu, apmaksas datumu vai atsauci
POST/invoices/send-bulkNosūtīt rēķinus iedzīvotājiem pa e-pastu
GET/invoices/:id/pdfLejupielādēt rēķinu PDF formātā

Skaitītāji

GET/metersSkaitītāju definīciju saraksts ēkā
POST/metersIzveidot jaunu skaitītāju
POST/meters/:id/readingsIesniegt skaitītāja rādījumu
POST/meters/ocrNolasīt rādījumu no skaitītāja foto, izmantojot AI OCR

Iedzīvotāji un lietotāji

GET/residentsIedzīvotāju saraksts, kas saistīti ar jūsu ēkām
POST/invitationsUzaicināt lietotāju uz dzīvokli
GET/invitationsGaistošo uzaicinājumu saraksts
DELETE/invitations/:idAtcelt uzaicinājumu

Maksājumi

POST/payments/banklinkUzsākt Paysera / Maksekeskus bankas saites maksājumu
GET/paymentsReģistrēto maksājumu saraksts jūsu īrniekam
POST/bank-statements/importImportēt CSV/XML bankas izrakstu automātiskai saskaņošanai

Tīmekļa āķi

GET/webhooksKonfigurēto webhook galapunktu saraksts
POST/webhooksIzveidot webhook galapunktu (URL + notikumu tipi)
DELETE/webhooks/:idDzēst webhook galapunktu

Webhook notikumu tipi

Abonējiet jebkuru notikumu kombināciju, veidojot webhook galapunktu.

invoice.createdJauns rēķins ir ģenerēts
invoice.sentRēķins nosūtīts iedzīvotājam pa e-pastu
invoice.paidRēķins atzīmēts kā apmaksāts (manuāli vai ar bankas saiti)
invoice.overdueRēķins nav apmaksāts pēc termiņa
payment.receivedMaksājums reģistrēts rēķinam
reading.submittedIedzīvotājs iesniedza skaitītāja rādījumu
reading.confirmedPārvaldnieks apstiprināja skaitītāja rādījumu
maintenance.createdIesniegts jauns remontdarbu pieteikums
maintenance.updatedRemontdarbu pieteikuma statuss mainījies

Piemēra dati

POST https://your-server.com/webhook X-Urbaneta-Signature: sha256=... { "event": "invoice.paid", "timestamp": "2025-02-01T10:30:00Z", "tenantId": "550e8400-e29b-41d4-a716-...", "data": { "invoiceId": "...", "amount": 142.50 } }

HTTP kļūdu kodi

400Nepareizs pieprasījumsNepareizs pieprasījuma saturs vai trūkst obligāto lauku
401Nav autorizētsTrūkst vai beidzies piekļuves tokens
403AizliegtsAutorizēts, bet nepietiekami tiesību
404Nav atrastsResurss nav atrasts vai nav pieejams jūsu nomniekam
409KonfliktsDublēts resurss (piem., dzīvokļa numurs jau eksistē)
422Validācijas kļūdaValidācija neizdevās — pārbaudiet atbildes errors masīvu
429Pārsniegts limitsPārāk daudz pieprasījumu — mēģiniet vēlreiz pēc Retry-After galvenes vērtības
500Servera kļūdaNegaidīta kļūda — sazinieties ar atbalstu, ja problēma atkārtojas

Gatavs integrācijai?

Piesakieties savā Urbaneta kontā, lai ģenerētu API atslēgas un konfigurētu tīmekļa āķus.

Doties uz vadības paneli