Risorse per agenti
Documentazione leggibile dalle macchine, file OpenAPI ed esempi pronti da copiare per coding agent e flussi di lavoro degli sviluppatori.
Punti di accesso leggibili dalle macchine
- /docs/llms.txt offre agli agenti una mappa breve e curata della documentazione API di VeriMails.
- /llms-full.txt raccoglie la documentazione principale in un unico file leggibile in Markdown.
- /docs.md riassume la documentazione pubblica per sviluppatori.
- /openapi.json e nel /openapi.yaml descrivono il contratto dell'API.
Documentazione in Markdown
Usa questi file quando carichi VeriMails in strumenti di sviluppo, sistemi di documentazione interna o nel contesto di un prompt.
- Panoramica della documentazione
- Riferimento principale dell'API
- Esempi di codice
- Verifica singola
- Verifica in blocco
- Trova Email
- Codici di risultato
- Gestione degli errori
Ordine di implementazione consigliato
Per una nuova integrazione, inizia con una singola richiesta di verifica, aggiungi la gestione degli errori e poi passa ai flussi in blocco se devi elaborare liste.
POST
/api/verify/single
POST
/api/bulk
POST
/api/find-email