Avalik API v1.0 (vana)

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

API v1.0 annab juurdepääsu järgmisele:

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

Kõik endpointid järgivad REST-i standardkonventsioone ja tagastavad JSON-vormingus andmeid. v1.0 on põhiliselt lugemiseks mõeldud API: luua saab ainult kliente, kontakte, ülesandeid ja veebihaagi tellimusi, midagi ei saa uuendada ning kustutada saab ainult veebihaagi tellimust (tellimusest loobumiseks). Kui pead Ukusse tagasi kirjutama, kasuta API v3.

• Ä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 töömahtu.
• 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 — planeeri 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 (old) API.
2. Sisesta oma API võtmepaarile 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 kohe juurdepääsu kõigile integratsioonidele, mis neid mandaate kasutavad.

Saada POST-päring sisselogimise endpointile 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...

Interaktiivne API dokumentatsioon on saadaval aadressil app.getuku.com/docs/sandbox/. Seal saad testida endpointe, vaadata päringu- ja vastuseskeeme ning proovida päringuid otse brauserist. Pane tähele, et veebihaagi tellimuse endpointi seal ei kajastata — see on olemas, aga sandbox seda ei dokumenteeri.

JWT tokenid aeguvad 10 minuti pärast. Kui token aegub, autendi uuesti, et saada uus. Kujunda oma integratsioon nii, et see käsitleks uuesti autentimist automaatselt.

• Hoia oma API salajast võtit konfidentsiaalsena. Kohtle seda nagu salasõna. Ära kunagi lisa seda versioonihaldusse ega jaga lihttekstina.
• Kasuta eraldi võtmepaare eri integratsioonide jaoks. Kui üks kompromiteeritakse, saad tühistada ainult selle võtme, ilma et see mõjutaks teisi.
• Tokenid on lühiajalised. 10-minutiline aegumisaken piirab kokkupuudet, kui token peaks pealtkuulamisel kätte langema.
• 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üpteeringut. Ära kunagi saada mandaate ega tokeneid tavalise HTTP kaudu.
• API juurdepääs on piiratud sinu ettevõttega. Iga võtmepaar on seotud kindla ettevõttega — saad juurde pääseda ainult oma ettevõttele kuuluvatele andmetele.