Hoppa till huvudinnehåll

Utvecklar-API och webhooks

Skapa API-nycklar, registrera webhook-slutpunkter och granska förfrågningsloggar från utvecklarcentret.

Skrivet av Sarah Chen

Utvecklarcentret är där du kopplar Exayard till din egen kod och dina egna verktyg. Öppna det från Inställningar och sedan Utvecklare. Härifrån skapar du API-nycklar, registrerar webhook-slutpunkter och granskar en live-logg över varje API-förfrågan. Endast organisationsadministratörer kan nå den här sidan.

API-nycklar

En API-nyckel autentiserar förfrågningar till Exayards API. Nycklar tillhör din organisation, så rätt konto väljs automatiskt och det finns inget organisations-ID att skicka.

Öppna fliken API-nycklar i kortet Autentiseringsuppgifter och klicka på knappen +. Ge nyckeln ett Namn och välj sedan dess Behörigheter (scopes). Välj Alla för att bevilja varje behörighet, eller Specifika för att välja enskilda rättigheter. Behörigheter följer en uppdelning i läs och skriv per resurs, som read:projects och write:estimates. Behörigheten admin:org ger fullständig åtkomst. Välj de minsta behörigheter din integration behöver.

Exayard visar den fullständiga nyckeln en gång, direkt efter att du har skapat den. Kopiera den då, för den visas aldrig igen. Därefter visas varje nyckel med sitt namn, en maskerad förhandsvisning som ak_••••1234 och datumet då den senast användes.

Använd pennikonen för att byta namn på en nyckel eller ändra dess behörigheter. Använd papperskorgsikonen för att Återkalla den. Återkallande är permanent och alla integrationer som använder den nyckeln slutar fungera omedelbart.

Samma nyckel autentiserar integrationerna utan kod. Se Ansluta Exayard till Zapier, Ansluta Exayard till Make och Ansluta Exayard till n8n. För åtkomst för agenter och AI-redigerare, se Ansluta till Claude och andra AI-verktyg.

Webhooks

En webhook talar om för Exayard att meddela din server när något händer. Öppna fliken Webhooks och klicka på + för att lägga till en slutpunkt. Ange den URL som ska ta emot leveranser och en valfri Beskrivning.

Välj vilka Händelser du vill prenumerera på. Välj Alla för att ta emot varje händelse, eller Specifika för att välja från listan:

Händelse

Inträffar när

project.created

Ett projekt skapas

project.updated

Ett projekt ändras

project.archived

Ett projekt arkiveras

assessment.started

En mängdavtagningsbedömning påbörjas

assessment.completed

En bedömning slutförs

assessment.approved

En bedömning godkänns

assessment.cancelled

En bedömning avbryts

estimate.generated

En kalkyl genereras

bid.generated

Ett anbud genereras

file.processed

En uppladdad fil slutförs bearbetningen

När du skapar en slutpunkt visar Exayard en signeringshemlighet en gång. Kopiera den då, för den visas inte igen.

Säkra webhook-leveranser

Varje leverans bär ett Exayard-Signature-huvud i formen t=<unix>,v1=<digest>. Exayard bygger signaturen genom att sammanfoga tidsstämpeln och förfrågningskroppen och sedan signera dem med HMAC-SHA256 med din slutpunktshemlighet.

För att verifiera en leverans, beräkna om signaturen med din hemlighet, bekräfta att tidsstämpeln är inom fem minuter från nu, och jämför sammanfattningarna (digests). Misslyckade leveranser görs om med exponentiell backoff under ungefär tre dagar.

För att redigera en slutpunkt klickar du på pennikonen. Du kan ändra URL, beskrivning och händelser, och ställa dess StatusAktiv eller Pausad. Pausade slutpunkter slutar ta emot leveranser. Samma dialog har en Rotera hemlighet-knapp. Att rotera utfärdar en ny hemlighet och den gamla slutar fungera omedelbart, så uppdatera din server innan du roterar. Papperskorgsikonen tar bort en slutpunkt och avslutar alla leveranser till den.

Snabbstart

Kortet Snabbstart rymmer en färdig prompt för en AI-redigerare som Claude eller Cursor. Klicka på Kopiera prompt och klistra in den i din redigerare. Prompten innehåller API:ets bas-URL, autentiseringsformatet, behörighetsvokabulären och webhookens signeringsschema, så att AI:n kan ställa i ordning en fungerande integration och be dig om de detaljer den behöver.

Dokumentation

Kortet Dokumentation länkar till de fullständiga utvecklardokumenten och OpenAPI-specifikationen, som beskriver varje rutt och schema. Anslut MCP öppnar konfigurationen för att ansluta AI-agenter direkt till Exayard.

Loggar

Sektionen Loggar registrerar dina senaste API-förfrågningar över både REST-API:et och MCP. Varje rad visar metoden, sökvägen, svarsstatusen och latensen. Välj en rad för att se dess fullständiga detaljer, inklusive förfrågnings-ID och förfrågnings- och svarskropparna. Använd loggarna för att bekräfta att ett anrop fungerade eller för att felsöka en integration som inte fungerar.

Fick du svar på din fråga?