Siirry pääsisältöön

Kehittäjän API ja webhookit

Luo API-avaimia, rekisteröi webhook-päätepisteitä ja tarkastele pyyntölokeja kehittäjäkeskuksesta.

Tekijä: Sarah Chen

Kehittäjäkeskus on paikka, jossa yhdistät Exayardin omaan koodiisi ja työkaluihisi. Avaa se kohdasta Asetukset ja sitten Kehittäjä. Täältä luot API-avaimia, rekisteröit webhook-päätepisteitä ja tarkastelet reaaliaikaista lokia jokaisesta API-pyynnöstä. Vain organisaation järjestelmänvalvojat pääsevät tälle sivulle.

API-avaimet

API-avain tunnistaa pyynnöt Exayardin API:in. Avaimet kuuluvat organisaatiollesi, joten oikea tili valitaan automaattisesti eikä organisaatiotunnusta tarvitse välittää.

Avaa API keys -välilehti Credentials-kortissa ja klikkaa +-painiketta. Anna avaimelle Nimi ja valitse sitten sen Oikeudet. Valitse Kaikki myöntääksesi jokaisen oikeuden tai Tietty valitaksesi yksittäisiä käyttöoikeuksia. Oikeudet noudattavat luku- ja kirjoitusjakoa resurssikohtaisesti, kuten read:projects ja write:estimates. Oikeus admin:org on täyden käyttöoikeuden myönnös. Valitse vähimmäisoikeudet, joita integraatiosi tarvitsee.

Exayard näyttää koko avaimen kerran, heti sen luomisen jälkeen. Kopioi se silloin, koska sitä ei näytetä enää koskaan. Sen jälkeen kukin avain näkyy nimineen, peitettynä esikatseluna kuten ak_••••1234 sekä päivämäärällä, jolloin sitä viimeksi käytettiin.

Käytä kynäkuvaketta nimetäksesi avaimen uudelleen tai muuttaaksesi sen oikeuksia. Käytä roskakorikuvaketta peruuttaaksesi sen. Peruuttaminen on pysyvää, ja kaikki kyseistä avainta käyttävät integraatiot lakkaavat toimimasta välittömästi.

Sama avain tunnistaa koodittomat integraatiot. Katso Exayardin yhdistäminen Zapieriin, Exayardin yhdistäminen Makeen ja Exayardin yhdistäminen n8n:ään. Agentti- ja tekoälyeditorikäyttöä varten katso Yhdistäminen Claudeen ja muihin tekoälytyökaluihin.

Webhookit

Webhook käskee Exayardia ilmoittamaan palvelimellesi, kun jotain tapahtuu. Avaa Webhooks-välilehti ja klikkaa + lisätäksesi päätepisteen. Syötä URL, jonka tulisi vastaanottaa toimituksia, sekä valinnainen Kuvaus.

Valitse, mitä Tapahtumia tilataan. Valitse Kaikki vastaanottaaksesi jokaisen tapahtuman tai Tietty valitaksesi luettelosta:

Tapahtuma

Laukeaa kun

project.created

Projekti luodaan

project.updated

Projektia muutetaan

project.archived

Projekti arkistoidaan

assessment.started

Määrälaskelman arviointi alkaa

assessment.completed

Arviointi valmistuu

assessment.approved

Arviointi hyväksytään

assessment.cancelled

Arviointi peruutetaan

estimate.generated

Arvio luodaan

bid.generated

Tarjous luodaan

file.processed

Ladatun tiedoston käsittely valmistuu

Kun luot päätepisteen, Exayard näyttää allekirjoitussalaisuuden kerran. Kopioi se silloin, koska sitä ei näytetä uudelleen.

Webhook-toimitusten suojaaminen

Jokainen toimitus kantaa Exayard-Signature-otsaketta muodossa t=<unix>,v1=<digest>. Exayard rakentaa allekirjoituksen yhdistämällä aikaleiman ja pyynnön rungon ja allekirjoittamalla ne sitten HMAC-SHA256:lla käyttäen päätepistesalaisuuttasi.

Varmistaaksesi toimituksen laske allekirjoitus uudelleen salaisuudellasi, vahvista, että aikaleima on viiden minuutin sisällä nykyhetkestä, ja vertaa tiivisteitä. Epäonnistuneet toimitukset uudelleenyritetään eksponentiaalisella perääntymisellä noin kolmen päivän ajan.

Muokataksesi päätepistettä klikkaa kynäkuvaketta. Voit muuttaa URL-osoitetta, kuvausta ja tapahtumia sekä asettaa sen Tilan arvoon Aktiivinen tai Keskeytetty. Keskeytetyt päätepisteet lakkaavat vastaanottamasta toimituksia. Samassa valintaikkunassa on Vaihda salaisuus -painike. Vaihtaminen luo uuden salaisuuden ja vanha lakkaa toimimasta välittömästi, joten päivitä palvelimesi ennen vaihtamista. Roskakorikuvake poistaa päätepisteen ja lopettaa kaikki toimitukset siihen.

Pika-aloitus

Pika-aloitus-kortti sisältää valmiin kehotteen tekoälyeditorille kuten Claudelle tai Cursorille. Klikkaa Kopioi kehote ja liitä se editoriisi. Kehote sisältää API:n perus-URL-osoitteen, tunnistautumismuodon, oikeuksien sanaston ja webhookin allekirjoitusmenetelmän, joten tekoäly voi rakentaa toimivan integraation rungon ja pyytää sinulta tarvitsemansa tiedot.

Dokumentaatio

Dokumentaatio-kortti linkittää täydelliseen kehittäjädokumentaatioon ja OpenAPI-määrittelyyn, joka kuvaa jokaisen reitin ja skeeman. Yhdistä MCP avaa määrityksen tekoälyagenttien yhdistämiseksi suoraan Exayardiin.

Lokit

Lokit-osio tallentaa viimeisimmät API-pyyntösi sekä REST API:n että MCP:n osalta. Kukin rivi näyttää menetelmän, polun, vastauksen tilan ja viiveen. Valitse rivi nähdäksesi sen täydet tiedot, mukaan lukien pyynnön tunnuksen sekä pyynnön ja vastauksen rungot. Käytä lokeja varmistaaksesi, että kutsu toimi, tai vianetsiäksesi epäonnistuvaa integraatiota.

Vastasiko tämä kysymykseesi?