Prijeđite na glavni sadržaj

Razvojni API i webhookovi

Izradite API ključeve, registrirajte webhook krajnje točke i pregledajte zapise zahtjeva iz Razvojnog centra.

Napisao/la Sarah Chen

Razvojni centar je mjesto gdje povezujete Exayard s vlastitim kodom i alatima. Otvorite ga iz Postavki, zatim Razvojni programer. Odavde stvarate API ključeve, registrirate krajnje točke webhookova i pregledavate uživo zapis svakog API zahtjeva. Samo administratori organizacije mogu doći do ove stranice.

API ključevi

API ključ autentificira zahtjeve prema Exayard API-ju. Ključevi pripadaju vašoj organizaciji, pa je pravi račun odabran automatski i nema ID-a organizacije za proslijediti.

Otvorite karticu API ključevi u kartici Vjerodajnice i kliknite gumb +. Dajte ključu Naziv, zatim odaberite njegove Opsege. Odaberite Sve kako biste dodijelili svaki opseg ili Specifične kako biste odabrali pojedinačne dozvole. Opsezi slijede podjelu na čitanje i pisanje po resursu, poput read:projects i write:estimates. Opseg admin:org je dodjela punog pristupa. Odaberite minimalne opsege koje vaša integracija treba.

Exayard prikazuje cijeli ključ jednom, odmah nakon što ga stvorite. Kopirajte ga tada, jer se više nikada neće prikazati. Nakon toga svaki se ključ pojavljuje sa svojim nazivom, maskiranim pregledom poput ak_••••1234 i datumom kada je posljednji put korišten.

Upotrijebite ikonu olovke za preimenovanje ključa ili promjenu njegovih opsega. Upotrijebite ikonu koša za Opoziv. Opoziv je trajan i bilo koja integracija koja koristi taj ključ odmah prestaje raditi.

Isti ključ autentificira integracije bez koda. Pogledajte Povezivanje Exayarda sa Zapierom, Povezivanje Exayarda s Makeom i Povezivanje Exayarda s n8n-om. Za pristup agenta i AI uređivača pogledajte Povezivanje s Claudeom i drugim AI alatima.

Webhookovi

Webhook govori Exayardu da obavijesti vaš poslužitelj kada se nešto dogodi. Otvorite karticu Webhookovi i kliknite + kako biste dodali krajnju točku. Unesite URL koji bi trebao primati dostave i neobavezni Opis.

Odaberite na koje se Događaje pretplatiti. Odaberite Sve kako biste primali svaki događaj ili Specifične kako biste odabrali s popisa:

Događaj

Aktivira se kada

project.created

Projekt je stvoren

project.updated

Projekt je promijenjen

project.archived

Projekt je arhiviran

assessment.started

Procjena premjera započinje

assessment.completed

Procjena završava

assessment.approved

Procjena je odobrena

assessment.cancelled

Procjena je otkazana

estimate.generated

Procjena je generirana

bid.generated

Ponuda je generirana

file.processed

Prenesena datoteka dovršava obradu

Kada stvorite krajnju točku, Exayard jednom prikazuje tajni ključ za potpisivanje. Kopirajte ga tada, jer se više ne prikazuje.

Osiguravanje dostava webhookova

Svaka dostava nosi zaglavlje Exayard-Signature u obliku t=<unix>,v1=<digest>. Exayard izgrađuje potpis spajanjem vremenske oznake i tijela zahtjeva, zatim ih potpisuje pomoću HMAC-SHA256 koristeći tajni ključ vaše krajnje točke.

Za provjeru dostave ponovno izračunajte potpis svojim tajnim ključem, potvrdite da je vremenska oznaka unutar pet minuta od sada i usporedite sažetke. Neuspjele dostave pokušavaju ponovno s eksponencijalnim odgodama tijekom otprilike tri dana.

Za uređivanje krajnje točke kliknite ikonu olovke. Možete promijeniti URL, opis i događaje te postaviti njezin Status na Aktivno ili Pauzirano. Pauzirane krajnje točke prestaju primati dostave. Isti dijaloški okvir ima gumb Zamijeni tajni ključ. Zamjena izdaje novi tajni ključ, a stari odmah prestaje raditi, pa ažurirajte svoj poslužitelj prije zamjene. Ikona koša briše krajnju točku i prekida sve dostave prema njoj.

Brzi početak

Kartica Brzi početak sadrži gotovi prompt za AI uređivač poput Claudea ili Cursora. Kliknite Kopiraj prompt i zalijepite ga u svoj uređivač. Prompt uključuje osnovni URL API-ja, format autentifikacije, vokabular opsega i shemu potpisivanja webhookova, pa umjetna inteligencija može izgraditi radnu integraciju i pitati vas za pojedinosti koje joj trebaju.

Dokumentacija

Kartica Dokumentacija povezuje se s cjelovitom razvojnom dokumentacijom i OpenAPI specifikacijom, koja opisuje svaku rutu i shemu. Poveži MCP otvara postavljanje za povezivanje AI agenata izravno s Exayardom.

Zapisi

Odjeljak Zapisi bilježi vaše najnovije API zahtjeve kroz REST API i MCP. Svaki redak prikazuje metodu, putanju, status odgovora i latenciju. Odaberite redak kako biste vidjeli njegove cjelovite pojedinosti, uključujući ID zahtjeva te tijela zahtjeva i odgovora. Upotrijebite zapise kako biste potvrdili da je poziv uspio ili otklonili pogreške u integraciji koja ne radi.

Jesmo li odgovorili na vaše pitanje?