Prijeđite na glavni sadržaj

Aplikacije za razvojne programere, API ključevi i webhookovi

Izradite aplikacije i API ključeve, testirajte u testnom okruženju, šaljite webhookove, instalirajte aplikacije drugih tvrtki te pregledajte zapisnike zahtjeva i potrošnju po ključu.

Napisao/la Sarah Chen

Postavke Za razvojne programere mjesto su na kojem povezujete Exayard s vlastitim kodom i s aplikacijama koje izrađuju druge tvrtke. Otvorite Postavke, a zatim Za razvojne programere. Ovu stavku u izborniku postavki vide samo administratori tvrtke. Član koji otvori stranicu može je pregledavati, ali ne može ništa mijenjati.

Aplikacije, API ključevi, webhookovi i zapisnici dostupni su u svakom paketu, uključujući besplatni. Naplaćuje se samo AI rad.

Aplikacije

Aplikacija je jedna od vaših integracija, primjerice "Acme estimator" ili "Noćna sinkronizacija". Svaki API ključ pripada nekoj aplikaciji. Aplikacije su prvi odjeljak na stranici. Može ga pregledavati svaki član. Samo administratori izrađuju i mijenjaju aplikacije.

Kliknite Nova aplikacija i ispunite polja Naziv, Opis, Početna stranica, E-adresa za podršku i Opsezi. Opsezi su za svaki resurs podijeljeni na čitanje i pisanje, primjerice read:projects i write:estimates. Aplikacije ne mogu tražiti opseg admin:org. Tvrtka može imati najviše 25 aplikacija.

Svaka aplikacija prikazuje kada je izrađena i svoje ograničenje broja zahtjeva, primjerice "Najviše 60 zahtjeva u minuti po tvrtki i ukupno 600". Izbornik Više radnji aplikacije sadrži:

  • Uredi mijenja pojedinosti i opsege aplikacije.

  • Webhook postavlja jednu adresu koja prima događaje iz svih tvrtki koje su instalirale aplikaciju.

  • Izbriši aplikaciju uklanja aplikaciju i opoziva sve njezine ključeve. Svaka tvrtka koja ju je instalirala gubi pristup.

API ključevi

API ključ omogućuje vašem vlastitom kodu pozivanje Exayard API-ja. Ključevi se nalaze unutar aplikacije, pod Ključevi. Ključ radi u tvrtki svoje aplikacije, pa nije potrebno prosljeđivati ID tvrtke.

Da biste izradili ključ, kliknite Novi ključ u aplikaciji. Unesite Naziv ključa, primjerice "Produkcija". Pod Opsezi odaberite Svi za sve opsege koje aplikacija ima ili Određeni za odabir manjeg broja. Ako je ključ namijenjen kratkotrajnom radu, postavite neobavezni datum pod Istječe. Ključ radi do kraja tog dana. Kliknite Izradi.

Exayard cijeli ključ prikazuje samo jednom. Tada ga kopirajte jer se više nikada neće prikazati. Exayard čuva samo šifriranu kopiju, pa se izgubljeni ključ ne može vratiti. Izradite novi i opozovite stari.

Ključ počinje s exa_live_. Ključ izrađen u testnom okruženju počinje s exa_test_. Nakon izrade ključ prikazuje svoj naziv, pregled poput exa_live_...AbCd i podatak Zadnje korišteno ili Nikad korišteno. Ključ s rokom valjanosti prikazuje Istječe i datum, a istekli ključ prikazuje Isteklo.

Aplikacija može imati najviše 25 aktivnih ključeva. Istekli ključ i dalje se ubraja u to ograničenje dok ga ne opozovete. Za zamjenu ključeva bez prekida izradite drugi ključ, prebacite poslužitelje na njega, a zatim opozovite prvi.

Otvorite izbornik Radnje s ključem da biste ključ preimenovali (Preimenuj) ili opozvali (Opozovi). Opoziv se ne može poništiti, a ključ prestaje raditi u roku od 30 sekundi.

Ako se ključ pojavi na javnom mjestu, primjerice u javnom repozitoriju koda, Exayard ga opoziva, šalje e-poruku vašim administratorima i zadržava ga na popisu s oznakom Pronađeno u javnom izvoru, opozvano.

Kada je druga tvrtka instalirala vašu aplikaciju, dijaloški okvir za novi ključ prikazuje i polje Radi u. Zadana vrijednost je Ova tvrtka. Sve tvrtke koje su je instalirale izrađuje ključ koji vaš poslužitelj koristi u svakoj od tih tvrtki. Svaki poziv tada navodi svoju tvrtku u zaglavlju Exayard-Organization-Id.

Isti ključevi povezuju alate bez kodiranja. Pogledajte Povezivanje Exayarda sa Zapierom, Povezivanje Exayarda s Makeom i Povezivanje Exayarda s n8n. Za AI asistente pogledajte Povezivanje Exe s vašim AI asistentom.

Stariji ključevi

Ključevi izrađeni prije nego što su ključevi pripadali aplikacijama počinju s ak_. I dalje rade, ali se novi ne mogu izrađivati. Prikazuju se pod Stariji ključevi na dnu stranice, samo dok ih ima.

Svaki administrator ondje vidi sve ključeve tvrtke, bez obzira na to tko ih je izradio. Ključ koji je izradio netko drugi prikazuje Izradio i ime te osobe. Svaka osoba vidi i svoje osobne ključeve. Kliknite ikonu koša za smeće da biste ključ opozvali (Opozovi). Odmah prestaje raditi.

Testna okruženja

Testno okruženje je testna tvrtka povezana s vašom. Koristite ga za izradu i testiranje integracije bez diranja vaših stvarnih projekata. Testna okruženja vide samo administratori.

Kliknite Novo testno okruženje, unesite Naziv i kliknite Izradi. Tvrtka može imati najviše 5 testnih okruženja. Otvori vas prebacuje u testno okruženje, a izbornik za promjenu tvrtke označava ga s Testno okruženje. Ondje na uobičajen način izradite aplikaciju i ključ. Njegovi ključevi počinju s exa_test_. Za prelazak u stvarni rad izradite istu aplikaciju i ključ u svojoj stvarnoj tvrtki i zamijenite ključ u svom kodu.

Testno okruženje prati paket vaše tvrtke, a vaša tvrtka plaća njegovu potrošnju. Nema vlastitu naplatu i ne dobiva vlastitu mjesečnu potrošnju AI-ja. Webhookovi i integracije rade kao u vašoj stvarnoj tvrtki.

Testno okruženje ne šalje e-poruke za dijeljenje ponuda ni potpisane primjerke osobama izvan njega i ne šalje SMS poruke. One se prikazuju kao "Nije poslano jer je ova tvrtka testno okruženje". Pozivnice za pridruživanje testnom okruženju šalju se uobičajeno.

Dokaznice mjera i čitanje datoteka u testnom okruženju besplatno vraćaju rezultate kopirane iz našeg oglednog projekta. Dokaznica mjera, njezine stranice i webhook o dovršetku dokaznice mjera označeni su kao primjeri. Kalkulacije, ponude, pretraživanje elemenata i chat također odgovaraju primjerima, bez naplate.

Da biste uklonili testno okruženje, kliknite Izbriši u njegovu retku, a zatim Izbriši testno okruženje. Testno okruženje se zatvara, njegovi ključevi prestaju raditi, a njegovi se podaci kasnije brišu.

Webhookovi

Webhook nalaže Exayardu da obavijesti vaš poslužitelj kada se nešto dogodi u vašoj tvrtki. Popis može pregledavati svaki član. Samo administratori dodaju i mijenjaju webhookove.

Kliknite Izradi webhook, unesite URL na koji trebaju stizati isporuke i dodajte neobavezni Opis. Odaberite koje Događaje želite slati. Odaberite Svi za primanje svih događaja, uključujući nove, ili Određeni za odabir s popisa. Svi događaji i njihov sadržaj navedeni su u katalogu webhook događaja.

Kada izradite webhook, Exayard jednom prikazuje njegov Tajni ključ za potpisivanje. Tada ga kopirajte jer se više neće prikazati.

Za ostalo otvorite izbornik Više radnji webhooka:

  • Uredi mijenja URL, opis i događaje te postavlja Status na Aktivno ili Pauzirano. Pauzirani webhook ne prima isporuke. Dijaloški okvir sadrži i Zamijeni tajni ključ. Stari tajni ključ odmah prestaje vrijediti, stoga najprije ažurirajte svoj poslužitelj.

  • Pošalji testni događaj šalje jedan događaj odabrane Vrste događaja. Dijaloški okvir čeka odgovor vašeg poslužitelja i prikazuje rezultat i kod odgovora. Testni događaj sadrži "test": true.

  • Isporuke navodi zadnjih 25 isporuka s njihovim događajem, statusom, kodom odgovora i brojem pokušaja. Isporuka je Na čekanju, Ponovni pokušaj, Isporučeno ili Neuspješno. Administratori mogu kliknuti Pošalji ponovno da bi ponovno poslali isporuku.

  • Izbriši webhook prekida sve isporuke prema tom URL-u.

Testni događaj i ponovno slanje šalju se jednom i nikada se ne pokušavaju ponovno.

Zaštita webhook isporuka

Svaka isporuka sadrži zaglavlje Exayard-Signature u obliku t=<unix>,v1=<digest>. Exayard izrađuje potpis spajanjem vremenske oznake i tijela zahtjeva, a zatim ih potpisuje algoritmom HMAC-SHA256 pomoću tajnog ključa vašeg webhooka.

Svaka isporuka sadrži i zaglavlja Exayard-Event-Id, Exayard-Event-Type i Exayard-Organization-Id. JSON tijelo ima polje organizationId koje navodi tvrtku iz koje događaj dolazi. Zaglavlje sadrži isti ID, pa isporuku možete usmjeriti prije nego što pročitate tijelo. Potpis obuhvaća cijelo tijelo, uključujući organizationId.

Budući da svaka isporuka navodi svoju tvrtku, jedna adresa primatelja može služiti mnogim tvrtkama. Registrirajte isti URL u svakoj tvrtki i usmjerite svaku isporuku prema organizationId. Svaki webhook ima vlastiti tajni ključ, pa prije provjere odaberite tajni ključ prema Exayard-Organization-Id.

Da biste provjerili isporuku, ponovno izračunajte potpis svojim tajnim ključem, potvrdite da je vremenska oznaka unutar pet minuta od trenutačnog vremena i usporedite sažetke.

Neuspjela isporuka pokušava se ukupno do 10 puta, tijekom otprilike 80 sati, s duljim razmacima između pokušaja. Svaki pokušaj šalje isto tijelo i isti ID događaja. Preusmjeravanje se smatra neuspjehom.

Dopustite drugim tvrtkama da instaliraju vašu aplikaciju

Vaša aplikacija radi u vašoj tvrtki čim je izradite. Svaka aplikacija ima i dio Dopusti drugim tvrtkama da instaliraju ovu aplikaciju. On prikazuje je li aplikacija Pregledano, Pregled zatražen ili Nije pregledano, njezine Adrese za prijavu, njezin ID klijenta i koliko je tvrtki može instalirati.

Administratori za sljedeće otvaraju izbornik Radnje instalacije:

  • Uredi adrese za prijavu postavlja adrese na koje Exayard vraća korisnike kada ih vaša aplikacija prijavljuje njihovim Exayard računom. Unesite jednu adresu po retku, najviše 10. Svaka mora počinjati s https://, ili s http://localhost dok testirate. Kada prvi put spremite adrese za prijavu, Exayard jednom prikazuje Tajni ključ klijenta aplikacije.

  • Kopiraj poveznicu za instalaciju kopira poveznicu koju možete poslati bilo kojoj tvrtki. Ona administratoru te tvrtke otvara dijaloški okvir za instalaciju.

  • Zatraži pregled šalje aplikaciju podršci Exayarda na pregled.

Nova aplikacija može se instalirati u najviše 25 tvrtki osim vaše i ne pojavljuje se u odjeljku Pronađi aplikacije. Tvrtke pod Računi za vaše klijente ne ubrajaju se u to ograničenje. Nakon odobrenja aplikacija prikazuje oznaku Pregledano i ograničenje broja instalacija se ukida. Upotrijebite Prikaži u odjeljku Pronađi aplikacije da biste je uvrstili u imenik svake tvrtke ili Sakrij iz odjeljka Pronađi aplikacije da biste je uklonili iz njega. Aplikacija sa statusom Obustavljeno ne može pozivati Exayard dok podrška ne ukine obustavu, a njezine instalacije ostaju sačuvane.

Kada aplikaciji uklonite opsege, sve ih instalacije odmah gube. Kada dodate opsege, svaka tvrtka zadržava svoj trenutačni pristup dok jedan od njezinih administratora ne odobri nove opsege.

Webhook aplikacije

Otvorite izbornik Više radnji aplikacije i kliknite Webhook. Unesite URL i kliknite Izradi, a zatim kopirajte Tajni ključ za potpisivanje, koji Exayard prikazuje samo jednom. Svaka tvrtka koja je instalirala aplikaciju šalje događaje obuhvaćene opsezima koje je dodijelila. Vaša aplikacija prima i app.installed, app.scopes_approved i app.uninstalled kada je tvrtka instalira, odobri širi pristup ili je ukloni. Isporuke navode svoju tvrtku i potpisane su na isti način kao ostali webhookovi.

Isti dijaloški okvir omogućuje Pauziraj i Nastavi za isporuke, Zamijeni tajni ključ i Izbriši webhook.

Povezane aplikacije

Odjeljak Povezane aplikacije navodi aplikacije instalirane u vašoj tvrtki. Vidi ga svaki član. Samo administratori instaliraju, uklanjaju i odobravaju aplikacije.

Svaki redak prikazuje naziv aplikacije, je li Pregledano, tvrtku koja ju je izradila, tko ju je i kada instalirao te opsege koji su joj dodijeljeni.

Instaliranje aplikacije

Otvorite poveznicu za instalaciju aplikacije ili kliknite Instaliraj pokraj nje u odjeljku Pronađi aplikacije. Dijaloški okvir prikazuje tko je izradio aplikaciju, je li pregledana i koje opsege traži. Zatim odaberite:

  • Tvrtka: bilo koja tvrtka u kojoj ste administrator. Tvrtka koja već ima aplikaciju označena je s (instalirano). Ponovnom instalacijom spremaju se vaši novi odabiri.

  • Projekti: Svi projekti ili Samo ovi projekti, pa označite one kojima aplikacija smije pristupiti, najviše 500. Aplikacija ne može pristupiti nijednom drugom projektu u tvrtki.

  • Mjesečno ograničenje AI-ja: najveći iznos koji AI rad aplikacije smije stajati vašu tvrtku u svakom obračunskom mjesecu, u vašoj valuti naplate. Ostavite polje prazno za Bez ograničenja.

Kliknite Instaliraj. Ako vas aplikacija prijavljuje, Exayard vas zatim vodi dalje kako biste dovršili prijavu u aplikaciju. Ako ste član, ali ne i administrator, dijaloški okvir navodi administrator koje tvrtke može instalirati aplikaciju. Kliknite Kopiraj poveznicu da biste mu je poslali.

Da biste kasnije promijenili projekte, ponovno otvorite poveznicu za instalaciju i instalirajte aplikaciju s novim odabirom.

Odobravanje šireg pristupa

Kada aplikacija zatraži dodatne opsege, njezin redak prikazuje Traži širi pristup s novim opsezima. Administrator ih dodjeljuje klikom na Odobri. Do tada aplikacija zadržava pristup koji je imala.

Uklanjanje aplikacije

Otvorite izbornik Više radnji aplikacije, kliknite Ukloni i potvrdite. Aplikacija odmah gubi pristup vašoj tvrtki, a njezini webhookovi prestaju. AI rad koji je već pokrenula i dalje se dovršava.

Pronađi aplikacije

Odjeljak Pronađi aplikacije nalazi se unutar odjeljka Povezane aplikacije. Navodi pregledane aplikacije koje su njihovi izrađivači odlučili objaviti. Aplikacija koju vaša tvrtka već ima prikazuje oznaku Instalirano. Kliknite Instaliraj kod bilo koje druge aplikacije da biste otvorili dijaloški okvir za instalaciju.

Vaše osobne veze

Odjeljak Vaše osobne veze navodi AI alate i druge aplikacije koje ste povezali sa svojim Exayard računom, poput ChatGPT-a ili Claudea. Nalazi se na vrhu odjeljka Povezane aplikacije i svoje veze vidite samo vi. Osobna veza djeluje u vaše ime, pa može pristupiti svemu čemu možete i vi.

Svaka veza prikazuje kada je prvi i zadnji put korištena te tvrtke u kojima je korištena. Da biste je zaustavili, otvorite njezin izbornik Više radnji, kliknite Ukloni i potvrdite. Njezin sljedeći poziv bit će odbijen. Veza ostaje na popisu s oznakom Uklonjeno, a Ponovno dopusti vraća joj pristup. Za povezivanje novog alata pogledajte Povezivanje Exe s vašim AI asistentom.

Računi za vaše klijente

Vaša aplikacija putem API-ja može izrađivati Exayard tvrtke za klijente koji Exayard koriste samo kroz vaš proizvod. Te tvrtke pripadaju vašoj tvrtki, a ona plaća AI rad koji se u njima izvodi. Nemaju vlastite članove, a vaše se aplikacije u njih instaliraju automatski.

Odjeljak Računi za vaše klijente prikazuje ih administratorima, s nazivom svake tvrtke (Naziv) i datumom izrade (Izrađeno). Kliknite Prepusti i potvrdite da biste je zatvorili. Svaka aplikacija u njoj gubi pristup.

Prvi koraci

Kartica Brzi početak sadrži gotov upit za AI uređivač kao što su Claude ili Cursor. Kliknite Kopiraj upit i zalijepite ga u svoj uređivač. Upit uključuje osnovni URL API-ja, format autentifikacije, opsege i shemu potpisivanja webhookova, kako bi AI mogao izraditi funkcionalnu integraciju i zatražiti od vas potrebne pojedinosti. Ovu karticu vide samo administratori jer je za nju potreban API ključ.

Kartica Dokumentacija putem gumba Otvori dokumentaciju vodi na potpunu dokumentaciju za razvojne programere, a sadrži i poveznicu na OpenAPI specifikaciju, koja opisuje svaku rutu i shemu. Administratori vide i Poveži s Claudeom ili Cursorom, što otvara postavljanje za povezivanje AI asistenata s Exayardom.

Zapisnici

Odjeljak Zapisnici prikazuje zahtjeve upućene API-ju, od najnovijih. Svaki redak prikazuje stupce Metoda, Putanja, Status, Vrijeme i Latencija. Kliknite Učitaj više na dnu da biste vidjeli starije zahtjeve.

Administratori vide sve zahtjeve. Članovi vide samo zahtjeve koji nisu stigli putem aplikacije.

Administratori mogu filtrirati prema stavci Aplikacija, a zatim prema jednom od ključeva te aplikacije. Svatko može upisati vrijednost u polje Krajnji korisnik da bi vidio samo zahtjeve tog klijenta. Krajnji korisnik je vaš vlastiti ID za jednog od vaših klijenata. Vaš ga kod šalje uz svaki zahtjev u zaglavlju Exayard-End-User. Nikada ne koristite e-adresu kao ID.

Odaberite redak za prikaz svih pojedinosti, uključujući ID zahtjeva, aplikaciju i krajnjeg korisnika te Tijelo zahtjeva i Tijelo odgovora. Zapisnike koristite za potvrdu da je poziv uspio ili da biste otkrili zašto integracija ne radi.

Potrošnja po ključu i krajnjem korisniku

Administratori vide koliko je svaka aplikacija potrošila ovaj mjesec u odjeljku Potrošnja po aplikaciji pod Postavke, a zatim Potrošnja. Ondje su navedene i vaše vlastite aplikacije. Pod svakom aplikacijom Po ključu prikazuje koliko je potrošio svaki ključ, a Najveći krajnji korisnici prikazuje pet krajnjih korisnika s najvećom potrošnjom. Potrošnja koja nije vezana uz neki od ključeva aplikacije prikazuje se kao Ostalo.

Mjesečno ograničenje AI-ja

Mjesečno ograničenje AI-ja aplikacije najveći je iznos koji njezin AI rad smije stajati vašu tvrtku u svakom obračunskom mjesecu. Da biste ga postavili, otvorite izbornik Više radnji aplikacije u odjeljku Potrošnja po aplikaciji i kliknite Postavi mjesečno ograničenje AI-ja. Unesite iznos u svojoj valuti naplate i kliknite Spremi. Spremite prazno polje da biste uklonili ograničenje.

Kada aplikacija dosegne ograničenje, njezin se AI rad odbija do kraja obračunskog mjeseca, čak i ako vaša tvrtka još ima preostale AI potrošnje. Vlastita ograničenja vaše tvrtke i dalje vrijede. AI rad koji ljudi sami pokrenu nikada se ne ubraja u ograničenje aplikacije.

Jesmo li odgovorili na vaše pitanje?