Ves al contingut principal

API per a desenvolupadors i webhooks

Crea claus d'API, registra punts de connexió de webhook i revisa els registres de sol·licituds des del Centre de desenvolupadors.

Escrit per Sarah Chen

El Centre de desenvolupadors és on connectes Exayard amb el teu propi codi i les teves pròpies eines. Obre'l des de Configuració i després Desenvolupador. Des d'aquí crees claus d'API, registres punts de connexió de webhook i revises un registre en directe de cada sol·licitud d'API. Només els administradors de l'organització poden accedir a aquesta pàgina.

Claus d'API

Una clau d'API autentica les sol·licituds a l'API d'Exayard. Les claus pertanyen a la teva organització, de manera que el compte correcte se selecciona automàticament i no cal passar cap identificador d'organització.

Obre la pestanya Claus d'API a la targeta Credencials i fes clic al botó +. Dona un Nom a la clau i després tria'n els Àmbits. Selecciona Tots per concedir tots els àmbits, o Específics per triar permisos individuals. Els àmbits segueixen una divisió de lectura i escriptura per recurs, com ara read:projects i write:estimates. L'àmbit admin:org és una concessió d'accés total. Tria els àmbits mínims que necessita la teva integració.

Exayard mostra la clau completa una sola vegada, just després de crear-la. Copia-la en aquell moment, perquè no es torna a mostrar mai més. Després d'això, cada clau apareix amb el seu nom, una previsualització emmascarada com ara ak_••••1234 i la data en què es va utilitzar per darrera vegada.

Utilitza la icona de llapis per canviar el nom d'una clau o modificar-ne els àmbits. Utilitza la icona de paperera per Revocar-la. La revocació és permanent i qualsevol integració que utilitzi aquesta clau deixa de funcionar immediatament.

La mateixa clau autentica les integracions sense codi. Consulta Connectar Exayard a Zapier, Connectar Exayard a Make i Connectar Exayard a n8n. Per a l'accés d'agents i editors d'IA, consulta Connectar amb Claude i altres eines d'IA.

Webhooks

Un webhook indica a Exayard que notifiqui el teu servidor quan passa alguna cosa. Obre la pestanya Webhooks i fes clic a + per afegir un punt de connexió. Introdueix l'URL que ha de rebre els lliuraments i una Descripció opcional.

Tria a quins Esdeveniments subscriure't. Selecciona Tots per rebre tots els esdeveniments, o Específics per triar de la llista:

Esdeveniment

Es dispara quan

project.created

Es crea un projecte

project.updated

Es modifica un projecte

project.archived

S'arxiva un projecte

assessment.started

Comença una avaluació d'amidament

assessment.completed

Finalitza una avaluació

assessment.approved

S'aprova una avaluació

assessment.cancelled

Es cancel·la una avaluació

estimate.generated

Es genera un pressupost

bid.generated

Es genera una oferta

file.processed

Un fitxer pujat acaba de processar-se

Quan crees un punt de connexió, Exayard mostra un secret de signatura una sola vegada. Copia'l en aquell moment, perquè no es torna a mostrar.

Assegurar els lliuraments de webhook

Cada lliurament porta una capçalera Exayard-Signature amb la forma t=<unix>,v1=<digest>. Exayard construeix la signatura unint la marca de temps i el cos de la sol·licitud, i després signant-los amb HMAC-SHA256 mitjançant el secret del teu punt de connexió.

Per verificar un lliurament, torna a calcular la signatura amb el teu secret, confirma que la marca de temps es troba dins dels cinc minuts respecte a ara i compara els resums. Els lliuraments fallits es reintenten amb retard exponencial durant aproximadament tres dies.

Per editar un punt de connexió, fes clic a la icona de llapis. Pots canviar l'URL, la descripció i els esdeveniments, i establir el seu Estat a Actiu o En pausa. Els punts de connexió en pausa deixen de rebre lliuraments. El mateix diàleg té un botó Rota el secret. Rotar emet un secret nou i l'antic deixa de funcionar immediatament, així que actualitza el teu servidor abans de rotar. La icona de paperera elimina un punt de connexió i acaba tots els lliuraments cap a ell.

Inici ràpid

La targeta Inici ràpid conté una indicació preparada per a un editor d'IA com ara Claude o Cursor. Fes clic a Copia la indicació i enganxa-la al teu editor. La indicació inclou l'URL base de l'API, el format d'autenticació, el vocabulari d'àmbits i l'esquema de signatura de webhooks, de manera que la IA pot bastir una integració funcional i demanar-te els detalls que necessita.

Documentació

La targeta Documentació enllaça amb la documentació completa per a desenvolupadors i amb l'especificació OpenAPI, que descriu cada ruta i esquema. Connecta MCP obre la configuració per connectar agents d'IA directament a Exayard.

Registres

La secció Registres anota les teves sol·licituds d'API més recents tant de l'API REST com de MCP. Cada fila mostra el mètode, la ruta, l'estat de la resposta i la latència. Selecciona una fila per veure'n tot el detall, inclòs l'identificador de la sol·licitud i els cossos de la sol·licitud i la resposta. Utilitza els registres per confirmar que una crida ha funcionat o per depurar una integració que falla.

Respon això a la vostra pregunta?