Avalik API — väliste tööriistade ühendus Ukuga

Ettevõtte omanikud ja Ettevõtte peakasutajad Elite paketiga.

Tee: Seaded & Äpid → Avalik API

Avalik API annab juurdepääsu järgmisele:

• Kliendid — klientide loetlemine, filtreerimine ja loomine
• Kontaktid — klientidega seotud kontaktisikute haldamine
• Kliendigrupid — kliendigrupi struktuuride lugemine
• Kliendi väljad — klientide kohandatud väljade definitsioonidele ja väärtustele juurdepääs
• Ülesanded — ülesannete loetlemine ja filtreerimine
• Ülesande väljad — ülesannete kohandatud väljade definitsioonidele ja väärtustele juurdepääs
• Ajakirjed — jälgitud ajaandmete päringud
• Kasutajad — kasutajate loetlemine
• Kasutajagrupid — kasutajagrupi struktuuride lugemine
• Arved — arveandmete päringud
• Lepingud — lepinguandmete päringud
• Tooted — toodete loetlemine ja haldamine
• Teemad — ülesannete teemade loetlemine
• Webhookid — reaalajas sündmuste teavituste tellimine

Kõik lõpp-punktid järgivad REST-i standardkonventsioone. Kasuta GET-i andmete lugemiseks, POST-i kirjete loomiseks ja DELETE-i seal, kus see on toetatud. Vastused tagastatakse JSON-vormingus.

• Ärianalüütika (BI) — tõmba ülesanded, ajakirjed, lepingud ja arved oma BI- või analüütikaplatvormi, et analüüsida klientide, kasutajate, teenuste või teemade kasumlikkust ja planeerida ressursse.
• Kohandatud integratsioonid — ühenda Uku sisemiste tööriistade või raamatupidamistarkvaraga, mida Uku sisseehitatud integratsioonid veel ei kata.
• Kohandatud töölauad — varusta sisemised tiimi töölauad reaalajas Uku andmetega.
• Andmete ekspordi torustikud — plaanipärased regulaarsed ekstraktid andmelattu.

1. Mine Seaded & Äpid juurde.
2. Leia äpide loendist Avalik API (Elite funktsioonide jaotis).
3. Ava äpp ja aktiveeri see oma ettevõtte jaoks.

1. Ava Avalik API äpp ja mine vahekaardile Seaded.
2. Sisesta oma API võtmepaari Nimi (näiteks „Raporteerimistööriist” või „Zapieri integratsioon”).
3. Klõpsa Loo uus API võti.
4. Sinu uus API võti ja API salajane võti ilmuvad tabelis. Kasuta kopeerimisnuppu iga väärtuse kopeerimiseks.

Saad luua mitu API võtmepaari eri integratsioonide jaoks. Kustuta võtmepaar, klõpsates tabelis prügikasti ikooni — see tühistab viivitamatult juurdepääsu kõigile integratsioonidele, mis kasutavad neid mandaate.

Saada POST-päring sisselogimise lõpp-punktile oma API võtme ja salajase võtmega:

POST https://app.getuku.com/api/v1.0/login
Content-Type: application/json

{
  "api_key": "your-api-key",
  "api_secret": "your-api-secret"
}

Vastus sisaldab JWT tokenit:

{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIs..."
  }
}

Lisa token kõikide järgnevate päringute autoriseerimispäisesse:

GET https://app.getuku.com/api/v1.0/clients
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Täielik interaktiivne API dokumentatsioon on saadaval aadressil app.getuku.com/docs/sandbox/. Seal saad testida lõpp-punkte, vaadata päringu- ja vastuseskeeme ning proovida päringuid otse brauserist.

JWT tokenid aeguvad pärast 10 minutit. Tokeni aegumisel autendi uuesti, et saada uus token. Kujunda oma integratsioon käsitlema uuesti autentimist automaatselt.

• Kasuta eraldi võtmepaare eri integratsioonide jaoks. Kui üks kompromiteeritakse, kustuta ainult see võti, ilma et see mõjutaks teisi.
• Tokenid on lühiajalised. 10-minutiline aegumisaken piirab kokkupuudet, kui token satub valedesse kätesse.
• Kustuta kasutamata võtmed. Kui lõpetad integratsiooni kasutamise, eemalda selle API võtmepaar viivitamatult.
• Kõik päringud nõuavad HTTPS-i. API baas-URL kasutab TLS-krüpteerimist. Ära saada mandaate ega tokeneid tavalise HTTP kaudu.
• API juurdepääs on ettevõttega piiratud. Iga võtmepaar on seotud konkreetse ettevõttega — saad juurde pääseda ainult oma ettevõttele kuuluvatele andmetele.

Kontrolli, et sinu ettevõttel on Elite pakett ja Avalik API äpp on aktiveeritud jaotises Seaded & Äpid. Ainult Ettevõtte omanikud ja Ettevõtte peakasutajad saavad API võtmeid luua.

Veendu, et saadad õiged api_key ja api_secret väärtused POST-päringus. Kontrolli, et võtmepaar pole kustutatud — kustutatud võtmed tühistatakse kohe.

JWT tokenid aeguvad 10 minuti pärast. Kujunda oma integratsioon automaatseks uuesti autentimiseks enne iga päringut või tokeni aegumisel (HTTP 401 vastus).

Iga API võtmepaar on seotud ühe konkreetse ettevõttega. Kui haldad mitut ettevõtet, genereeri eraldi võtmepaar iga ettevõtte jaoks.