Direct la conținutul principal

API pentru dezvoltatori și webhook-uri

Creează chei API, înregistrează puncte finale de webhook și examinează jurnalele de cereri din Centrul pentru dezvoltatori.

Scris de Sarah Chen

Centrul pentru dezvoltatori este locul unde conectezi Exayard la propriul tău cod și la propriile tale instrumente. Deschide-l din Setări, apoi Dezvoltator. De aici creezi chei API, înregistrezi puncte finale de webhook și examinezi un jurnal live al fiecărei cereri API. Doar administratorii de organizație pot accesa această pagină.

Chei API

O cheie API autentifică cererile către API-ul Exayard. Cheile aparțin organizației tale, așa că este selectat automat contul potrivit și nu există niciun ID de organizație de transmis.

Deschide fila Chei API din cardul Acreditări și dă clic pe butonul +. Dă cheii un Nume, apoi alege-i Permisiunile. Selectează Toate pentru a acorda fiecare permisiune sau Specifice pentru a alege permisiuni individuale. Permisiunile urmează o împărțire de citire și scriere per resursă, precum read:projects și write:estimates. Permisiunea admin:org este o acordare de acces complet. Alege permisiunile minime de care are nevoie integrarea ta.

Exayard afișează cheia completă o singură dată, imediat după ce o creezi. Copiaz-o atunci, deoarece nu este afișată niciodată din nou. După aceea, fiecare cheie apare cu numele său, o previzualizare mascată precum ak_••••1234 și data la care a fost folosită ultima dată.

Folosește pictograma creion pentru a redenumi o cheie sau a-i schimba permisiunile. Folosește pictograma coș de gunoi pentru a o Revoca. Revocarea este permanentă și orice integrare care folosește acea cheie încetează să mai funcționeze imediat.

Aceeași cheie autentifică integrările fără cod. Vezi Conectarea Exayard la Zapier, Conectarea Exayard la Make și Conectarea Exayard la n8n. Pentru acces de la agenți și editoare AI, vezi Conectarea la Claude și alte instrumente AI.

Webhook-uri

Un webhook îi spune Exayard să-ți notifice serverul când se întâmplă ceva. Deschide fila Webhook-uri și dă clic pe + pentru a adăuga un punct final. Introdu URL-ul care ar trebui să primească livrările și o Descriere opțională.

Alege la care Evenimente să te abonezi. Selectează Toate pentru a primi fiecare eveniment sau Specifice pentru a alege din listă:

Eveniment

Se declanșează când

project.created

Un proiect este creat

project.updated

Un proiect este modificat

project.archived

Un proiect este arhivat

assessment.started

O evaluare de antemăsurătoare începe

assessment.completed

O evaluare se finalizează

assessment.approved

O evaluare este aprobată

assessment.cancelled

O evaluare este anulată

estimate.generated

O estimare este generată

bid.generated

O ofertă este generată

file.processed

Un fișier încărcat își finalizează procesarea

Când creezi un punct final, Exayard afișează un secret de semnare o singură dată. Copiază-l atunci, deoarece nu este afișat din nou.

Securizarea livrărilor de webhook

Fiecare livrare poartă un antet Exayard-Signature în forma t=<unix>,v1=<digest>. Exayard construiește semnătura prin alăturarea marcajului de timp și a corpului cererii, apoi semnându-le cu HMAC-SHA256 folosind secretul punctului tău final.

Pentru a verifica o livrare, recalculează semnătura cu secretul tău, confirmă că marcajul de timp este în interval de cinci minute față de momentul actual și compară valorile digest. Livrările eșuate se reîncearcă cu retragere exponențială pe parcursul a aproximativ trei zile.

Pentru a edita un punct final, dă clic pe pictograma creion. Poți schimba URL-ul, descrierea și evenimentele și seta Starea sa la Activ sau În pauză. Punctele finale în pauză încetează să mai primească livrări. Același dialog are un buton Rotește secretul. Rotirea emite un secret nou, iar cel vechi încetează să mai funcționeze imediat, așa că actualizează-ți serverul înainte de a roti. Pictograma coș de gunoi șterge un punct final și încheie toate livrările către el.

Pornire rapidă

Cardul Pornire rapidă conține un prompt gata făcut pentru un editor AI precum Claude sau Cursor. Dă clic pe Copiază promptul și lipește-l în editorul tău. Promptul include URL-ul de bază al API-ului, formatul de autentificare, vocabularul de permisiuni și schema de semnare a webhook-urilor, astfel încât AI-ul poate schela o integrare funcțională și îți poate cere detaliile de care are nevoie.

Documentație

Cardul Documentație trimite către documentația completă pentru dezvoltatori și către specificația OpenAPI, care descrie fiecare rută și schemă. Conectează MCP deschide configurarea pentru conectarea agenților AI direct la Exayard.

Jurnale

Secțiunea Jurnale înregistrează cele mai recente cereri API ale tale, atât prin API-ul REST, cât și prin MCP. Fiecare rând arată metoda, calea, starea răspunsului și latența. Selectează un rând pentru a-i vedea detaliile complete, inclusiv ID-ul cererii și corpurile cererii și răspunsului. Folosește jurnalele pentru a confirma că un apel a funcționat sau pentru a depana o integrare care eșuează.

Ați primit răspuns la întrebare?