Vai al contenuto principale

API per sviluppatori e webhook

Crea chiavi API, registra endpoint webhook e consulta i log delle richieste dal Centro sviluppatori.

Scritto da Sarah Chen

Il Centro sviluppatori è il luogo in cui colleghi Exayard al tuo codice e ai tuoi strumenti. Aprilo da Impostazioni, poi Sviluppatore. Da qui crei chiavi API, registri endpoint webhook e consulti un log in tempo reale di ogni richiesta API. Solo gli amministratori dell'organizzazione possono accedere a questa pagina.

Chiavi API

Una chiave API autentica le richieste verso l'API di Exayard. Le chiavi appartengono alla tua organizzazione, quindi l'account corretto viene selezionato automaticamente e non c'è alcun ID organizzazione da passare.

Apri la scheda Chiavi API nella scheda Credenziali e clicca il pulsante +. Assegna alla chiave un Nome, poi scegli i suoi Ambiti. Seleziona Tutti per concedere ogni ambito, oppure Specifici per scegliere singole autorizzazioni. Gli ambiti seguono una suddivisione tra lettura e scrittura per risorsa, come read:projects e write:estimates. L'ambito admin:org è una concessione di accesso completo. Scegli il minimo di ambiti di cui la tua integrazione ha bisogno.

Exayard mostra la chiave completa una sola volta, subito dopo averla creata. Copiala in quel momento, perché non viene più mostrata. Dopodiché, ogni chiave compare con il suo nome, un'anteprima mascherata come ak_••••1234 e la data dell'ultimo utilizzo.

Usa l'icona della matita per rinominare una chiave o modificarne gli ambiti. Usa l'icona del cestino per Revocarla. La revoca è permanente e qualsiasi integrazione che usa quella chiave smette di funzionare immediatamente.

La stessa chiave autentica le integrazioni no-code. Consulta Collegare Exayard a Zapier, Collegare Exayard a Make e Collegare Exayard a n8n. Per l'accesso ad agenti ed editor IA, consulta Collegarsi a Claude e ad altri strumenti IA.

Webhook

Un webhook indica a Exayard di notificare il tuo server quando accade qualcosa. Apri la scheda Webhook e clicca + per aggiungere un endpoint. Inserisci l'URL che deve ricevere le consegne e una Descrizione facoltativa.

Scegli a quali Eventi iscriverti. Seleziona Tutti per ricevere ogni evento, oppure Specifici per scegliere dall'elenco:

Evento

Si attiva quando

project.created

Viene creato un progetto

project.updated

Un progetto viene modificato

project.archived

Un progetto viene archiviato

assessment.started

Inizia una valutazione di rilievo

assessment.completed

Una valutazione si conclude

assessment.approved

Una valutazione viene approvata

assessment.cancelled

Una valutazione viene annullata

estimate.generated

Viene generato un preventivo

bid.generated

Viene generata un'offerta

file.processed

Un file caricato termina l'elaborazione

Quando crei un endpoint, Exayard mostra un segreto di firma una sola volta. Copialo in quel momento, perché non viene più mostrato.

Proteggere le consegne dei webhook

Ogni consegna porta un'intestazione Exayard-Signature nella forma t=<unix>,v1=<digest>. Exayard costruisce la firma unendo la marca temporale e il corpo della richiesta, poi firmandoli con HMAC-SHA256 usando il segreto del tuo endpoint.

Per verificare una consegna, ricalcola la firma con il tuo segreto, conferma che la marca temporale rientri nei cinque minuti rispetto a ora, e confronta i digest. Le consegne fallite vengono ritentate con backoff esponenziale per circa tre giorni.

Per modificare un endpoint, clicca l'icona della matita. Puoi cambiare URL, descrizione ed eventi, e impostare il suo Stato su Attivo o In pausa. Gli endpoint in pausa smettono di ricevere consegne. La stessa finestra ha un pulsante Ruota segreto. La rotazione emette un nuovo segreto e quello vecchio smette di funzionare immediatamente, quindi aggiorna il tuo server prima di ruotare. L'icona del cestino elimina un endpoint e interrompe tutte le consegne verso di esso.

Avvio rapido

La scheda Avvio rapido contiene un prompt già pronto per un editor IA come Claude o Cursor. Clicca Copia prompt e incollalo nel tuo editor. Il prompt include l'URL di base dell'API, il formato di autenticazione, il vocabolario degli ambiti e lo schema di firma dei webhook, così l'IA può impalcare un'integrazione funzionante e chiederti i dettagli di cui ha bisogno.

Documentazione

La scheda Documentazione rimanda alla documentazione completa per sviluppatori e alla specifica OpenAPI, che descrive ogni route e schema. Collega MCP apre la configurazione per collegare gli agenti IA direttamente a Exayard.

Log

La sezione Log registra le tue richieste API più recenti sia dell'API REST sia di MCP. Ogni riga mostra il metodo, il percorso, lo stato della risposta e la latenza. Seleziona una riga per vederne il dettaglio completo, incluso l'ID della richiesta e i corpi della richiesta e della risposta. Usa i log per confermare che una chiamata ha funzionato o per eseguire il debug di un'integrazione che fallisce.

Hai ricevuto la risposta alla tua domanda?