API REST (partner)
API pubblica per integrazioni server-to-server e agent AI — leggi e scrivi lead, deal, preventivi, contratti e messaggi del tuo Account con una sola API Key.
Versione Markdown di questa pagina
Scarica o copia il contenuto di questa pagina in formato .md — utile per fornirlo a un agente AI che integra questa specifica feature.
L'API REST partner di Audin è pensata per integrazioni server-to-server e per l'uso programmatico da parte di agent AI. Con una singola Account API Key puoi leggere e scrivere tutte le risorse del tuo Account: lead, aziende, deal, preventivi, contratti, attività, messaggi ed email.
L'API consuma le stesse rotte che il dashboard (app.audin.ai) usa
internamente: ciò che vedi nell'interfaccia è ciò che puoi automatizzare via API.
Stai integrando con un agent AI?
Scarica (o copia) il playbook pensato per un agent di coding: lo guida a intervistarti sul tuo stack e ad adattare l'integrazione, invece di prescrivere un'unica strada.
Questa documentazione è un hub narrativo: spiega concetti, convenzioni e guide per gruppo di risorse con esempi reali. La reference esaustiva endpoint-per-endpoint (schema body, query param, response) resta sullo Swagger: api.audin.ai/docs/partners.
A chi serve
CRM / ERP di terze parti
Sincronizza lead e deal tra il tuo gestionale e Audin.
Agent AI
Assistenti conversazionali che orchestrano flussi commerciali (creano deal, inviano preventivi).
Tool di automazione
Zapier, n8n, Make e simili che integrano il CRM Audin.
Cosa offre
- CRM anagrafiche — lead, aziende, commenti, tag.
- Pipeline & operatività — pipeline (deal/attività), deal con righe prodotto e termini di pagamento, attività e relativi template.
- Documenti — prodotti, categorie prodotto, clausole, template documento, preventivi, contratti.
- Messaging & email — conversazioni, template WhatsApp, invio e stato messaggi, stato delle email Audin Mail.
- Lettura & sistema — utenti piattaforma, ruoli, log delle call, numeri, health, version e log delle proprie chiamate API.
Cosa non offre (per ora)
- Webhook / push notification sugli eventi: il modello è polling-only. Per gli stati che evolvono nel tempo (es. firma di un contratto) interroghi periodicamente la risorsa.
- Gestione cross-account: una API Key opera su un solo Account.
- Configurazione di bot AI e campagne outbound: disponibili solo dal dashboard.
Accesso account-level
L'autenticazione avviene tramite l'header X-API-Key con una chiave nel formato
aud_acc_xxxx…. Ogni chiave è legata a un singolo Account e ha accesso
admin-equivalent su tutte le risorse di quell'Account. Per i dettagli su come
ottenerla, sul modello di sicurezza e su cosa implica l'accesso account-level,
vedi Autenticazione.
L'API Key è un segreto: usala esclusivamente lato server (mai in un browser o client pubblico). Vedi Autenticazione per le best practice.
Da dove iniziare
Autenticazione
Ottieni l'API Key, l'header X-API-Key e cosa implica l'accesso account-level.
Formato & convenzioni
JSON raw, formato degli errori, status code, paginazione e filtri.
Idempotency & rate limit
Header Idempotency-Key, rate limit per chiave e limiti operativi.
CRM anagrafiche
Lead, aziende, commenti e tag.
Pipeline & deal
Pipeline, deal, prodotti, termini di pagamento e attività.
Documenti
Prodotti, clausole, template, preventivi e contratti.
Messaging & email
Conversazioni, template WhatsApp, invio messaggi e stato email.
Lettura & sistema
Utenti, ruoli, call, numeri e endpoint di sistema.
Flussi operativi
Esempi end-to-end: apertura opportunità, invio preventivo, firma contratto.
Errori & deprecati
Glossario dei codici di errore e endpoint deprecati.