Gå til hovedinnhold

Utvikler-API og webhooks

Opprett API-nøkler, registrer webhook-endepunkter og gjennomgå forespørselslogger fra Utviklersenteret.

Skrevet av Sarah Chen

Utviklersenteret er der du kobler Exayard til din egen kode og dine egne verktøy. Åpne det fra Innstillinger og deretter Utvikler. Herfra oppretter du API-nøkler, registrerer webhook-endepunkter og går gjennom en live logg over hver API-forespørsel. Bare organisasjonsadministratorer kan nå denne siden.

API-nøkler

En API-nøkkel autentiserer forespørsler til Exayard-API-et. Nøkler tilhører organisasjonen din, så riktig konto velges automatisk og det finnes ingen organisasjons-ID å oppgi.

Åpne fanen API-nøkler i kortet Legitimasjon og klikk på +-knappen. Gi nøkkelen et Navn, og velg deretter dens Tilgangsområder. Velg Alle for å gi hvert tilgangsområde, eller Spesifikke for å plukke ut individuelle tillatelser. Tilgangsområder følger en lese- og skrive-deling per ressurs, som read:projects og write:estimates. Tilgangsområdet admin:org er en fulltilgangstildeling. Velg de minste tilgangsområdene integrasjonen din trenger.

Exayard viser hele nøkkelen én gang, rett etter at du har opprettet den. Kopier den da, for den vises aldri igjen. Etter det vises hver nøkkel med navnet sitt, en maskert forhåndsvisning som ak_••••1234, og datoen den sist ble brukt.

Bruk blyantikonet for å gi nytt navn til en nøkkel eller endre tilgangsområdene. Bruk søppelbøtteikonet for å Tilbakekalle den. Tilbakekalling er permanent, og enhver integrasjon som bruker den nøkkelen slutter å fungere umiddelbart.

Den samme nøkkelen autentiserer de kodefrie integrasjonene. Se Koble Exayard til Zapier, Koble Exayard til Make og Koble Exayard til n8n. For agent- og AI-editortilgang, se Koble til Claude og andre AI-verktøy.

Webhooks

En webhook ber Exayard om å varsle serveren din når noe skjer. Åpne fanen Webhooks og klikk på + for å legge til et endepunkt. Skriv inn URL-en som skal motta leveranser og en valgfri Beskrivelse.

Velg hvilke Hendelser du vil abonnere på. Velg Alle for å motta hver hendelse, eller Spesifikke for å plukke fra listen:

Hendelse

Utløses når

project.created

Et prosjekt opprettes

project.updated

Et prosjekt endres

project.archived

Et prosjekt arkiveres

assessment.started

En oppmålingsvurdering begynner

assessment.completed

En vurdering fullføres

assessment.approved

En vurdering godkjennes

assessment.cancelled

En vurdering avbrytes

estimate.generated

Et estimat genereres

bid.generated

Et tilbud genereres

file.processed

En opplastet fil fullfører behandlingen

Når du oppretter et endepunkt, viser Exayard en signeringshemmelighet én gang. Kopier den da, for den vises ikke igjen.

Sikre webhook-leveranser

Hver leveranse bærer en Exayard-Signature-overskrift på formen t=<unix>,v1=<digest>. Exayard bygger signaturen ved å slå sammen tidsstemplet og forespørselsteksten, og signerer dem deretter med HMAC-SHA256 ved hjelp av endepunkthemmeligheten din.

For å verifisere en leveranse, rekompuér signaturen med hemmeligheten din, bekreft at tidsstemplet er innenfor fem minutter fra nå, og sammenlign sammendragene. Mislykkede leveranser prøver på nytt med eksponentiell tilbaketrekking over omtrent tre dager.

For å redigere et endepunkt, klikk på blyantikonet. Du kan endre URL-en, beskrivelsen og hendelsene, og sette dens Status til Aktiv eller Pauset. Pausede endepunkter slutter å motta leveranser. Den samme dialogboksen har en Roter hemmelighet-knapp. Rotering utsteder en ny hemmelighet og den gamle slutter å fungere umiddelbart, så oppdater serveren din før du roterer. Søppelbøtteikonet sletter et endepunkt og avslutter alle leveranser til det.

Hurtigstart

Kortet Hurtigstart inneholder en ferdiglaget prompt for en AI-editor som Claude eller Cursor. Klikk Kopier prompt og lim den inn i editoren din. Prompten inkluderer basis-URL-en til API-et, autentiseringsformatet, tilgangsområde-vokabularet og webhook-signeringsskjemaet, slik at AI-en kan stillasere en fungerende integrasjon og spørre deg om detaljene den trenger.

Dokumentasjon

Kortet Dokumentasjon lenker til den fullstendige utviklerdokumentasjonen og OpenAPI-spesifikasjonen, som beskriver hver rute og hvert skjema. Koble til MCP åpner oppsettet for å koble AI-agenter direkte til Exayard.

Logger

Seksjonen Logger registrerer dine nyeste API-forespørsler på tvers av både REST-API-et og MCP. Hver rad viser metoden, banen, svarstatusen og responstiden. Velg en rad for å se hele detaljen, inkludert forespørsels-ID-en og forespørsels- og svarteksten. Bruk loggene til å bekrefte at et kall fungerte eller til å feilsøke en sviktende integrasjon.

Svarte dette på spørsmålet?