Korisničke upute – Softverske integracije putem API-ja

 

U ovom ćete članku doznati sljedeće:

  1. Interaktivna API dokumentacija
  2. Upravljate osobnim pristupnim tokenima
  3. Upravljajte webhookovima u sklopu svog račun
  4. Dajte korisnicima dopuštenje za pristup API funkcionalnostima

 

Softverske integracije putem API-ja

PlanRadar omogućava web API (sučelje za programiranje aplikacija) i webhookove. Ove Vam značajke omogućavaju integraciju softvera treće strane ili softvera napravljenog po mjeri s Vašim PlanRadar računom.

Korištenje API-ja zahtijeva određeno znanje o razvoju softvera. Uključite tim za razvoj softvera prilikom pristupa API-ju i njegova uspostavljanja. Nažalost, PlanRadar ne može pružiti razvoj softvera po mjeri u ime naših klijenata.

 

Interaktivna API dokumentacija

Prije nastavka provjerite imate li dopuštenja za pristup API značajkama. Potom možete pristupiti API dokumentaciji putem Postavke > API dokumentacija:

 

Možete izravno isprobati sve krajnje točke. Za pojedine krajnje točke morate navesti ID projekta ili ID ticketa koji obično možete pronaći i kopirati s URL-a prilikom pregleda određenog projekta ili ticketa.

Moći ćete kopirati i zalijepiti „curl“ naredbu i testirati API na komandnom sučelju (eng. command shell). Međutim, trebat će vam pristupni token koji je opisan u sljedećem odjeljku.

 

Upravljajte osobnim pristupnim tokenima

Koristite osobne pristupne tokene kako biste omogućili provjeru autentičnosti vanjskog softvera na našim poslužiteljima prilikom korištenja API-ja.

Prije nastavka provjerite imate li dopuštenja za pristup API značajkama. Osobne pristupne tokene možete stvoriti i njima upravljati pod Postavke > Profil > Osobni pristupni tokeni.

 

Tokeni su dodijeljeni korisniku. Ne smijete ih dijeliti s drugima te s njima trebate pažljivo postupati. Svatko tko ima pristupni token mogao bi pristupiti Vašem računu i djelovati u Vaše ime.

 

Prema zadanim postavkama, maksimalno ograničenje iznosi 30 zahtjeva/minuti. Na zahtjev se ovo ograničenje može povećati, obratite nam se na [email protected].
 

Upravljajte webhookovima u sklopu svog računa

Webhookovi omogućuju vanjskom softveru da reagira na događaje koji se zbivaju unutar PlanRadara kao što su „ticket je stvoren”, „ticket je ažuriran”, „fotografija je priložena”, itd. Webhookove možete stvarati te njima upravljati pod Postavke > Račun > Webhooks.

Ova postavka dostupna je samo vlasnicima računa.

 

Kliknite na „Dodajte novi webhook“. Ovdje ćete moći odabrati događaje o kojima će Vaš vanjski softver biti obaviješten.

 

Provjera autentičnosti:
Ovdje možete konfigurirati kako možemo provjeriti autentičnost s Vašim poslužiteljem. Trenutno podržavamo „HTTP osnovnu provjeru autentičnosti” s korisničkim imenom i lozinkom.

 

Zaglavlja:
Ako u zaglavlju želite unijeti dodatna polja za svoju uslugu, ovdje ih možete konfigurirati. Za lozinke ili tajne nudimo mogućnost skrivanja vrijednosti u korisničkom sučelju. Ako nešto želite sakriti, iz sigurnosnih razloga to nećete moći vratiti u korisničko sučelje nakon spremanja Webhooka.

 

Dajte korisnicima dopuštenje za pristup API funkcionalnostima

Stranicama API dokumentacije i osobnih pristupnih tokena možete pristupiti samo s odgovarajućim ovlaštenjima korisnika. Nositeljima računa automatski će se dodijeliti pristup API dokumentaciji.

Kako biste drugim internim korisnicima dali odgovarajuća dopuštenja, idite na Upravljanje korisnicima > Korisnici (upravljanje korisnicima) i zatim uredite ili stvorite novog internog korisnika i označite dopuštenje za pristup API-ju.

 

Poništavanje pristupnih tokena drugih korisnika

Imate mogućnost ukloniti pristupne tokene koje su stvorili drugi interni korisnici. Kako biste izbrisali pristupne tokene, morate imati dopuštenje za upravljanje korisnicima.  

Za uklanjanje pristupnog tokena koji je stvorio korisnik idite na Upravljanje korisnicima > Korisnici (upravljanje korisnicima) putem navigacijske trake. Ovdje odaberite internog korisnika čiji token želite ukloniti iz sustava. Vidjet ćete da su korisnici stvorili tokene na desnoj strani, a odavde ih možete izbrisati.  

 

Napomena: Drugi korisnici ne mogu izbrisati pristupne tokene koje je stvorio vlasnik računa. Samo vlasnik računa može izbrisati vlastite pristupne tokene tako što će otvoriti Postavke > Profil > Osobni pristupni token. 

Natrag u Sadržaj.