Endpoint principali

L'API è organizzata per risorse, ognuna con i propri endpoint. Ecco una mappa delle aree principali.

Quick start

Tre snippet pronti per chiamare l’API esterna. Sostituisci `yr_live_xxx` con la tua chiave personale (vedi pagina “Chiavi API e autenticazione”).

curl -X GET "https://api.yourang.ai.io/external/v1/contacts?limit=20" \
  -H "Authorization: Bearer yr_live_xxx" \
  -H "Accept: application/json"

Aree dell'API

• Contatti. Leggere, creare, aggiornare contatti del CRM. Sincronizzazioni bidirezionali con sistemi gestionali, import periodici da fonti esterne.
• Chiamate. Recuperare lo storico chiamate con metadati, trascrizioni, riepiloghi. Scatenare chiamate outbound programmaticamente.
• Prenotazioni. Creare, leggere, modificare prenotazioni. Sincronizzare il calendario yourang.ai con il PMS o gestionale.
• Ordini. Per il modulo Negozio: creare ordini da sistemi esterni, leggere lo stato, ricevere conferme di pagamento.
• Documenti. Caricare e gestire la base di conoscenza via API. Utile per chi mantiene il catalogo/listino in un sistema sorgente e vuole replicare in yourang.ai.
• Webhook. Configurare gli URL a cui yourang.ai notifica eventi (vedi pagina dedicata).

Casi d'uso tipici

• Sync gestionale → yourang.ai. Ogni notte il PMS pubblica i nuovi contatti e le prenotazioni del giorno a yourang.ai. L'assistente vocale lavora con dati sempre allineati.
• yourang.ai → gestionale. Quando l'assistente registra una nuova prenotazione, la riporta al gestionale principale tramite API. L'assistente diventa un canale di input al sistema centrale.
• Dashboard custom. Un BI o un foglio Excel collegato all'API mostra dati aggregati personalizzati, oltre quelli del pannello standard.
• Automazioni con n8n / Make. Workflow no-code che reagiscono a eventi yourang.ai per orchestrare azioni in altri sistemi: Slack, Notion, Airtable.

Paginazione e filtri

Tutti gli endpoint di lista supportano paginazione (limit + offset) e filtri sui campi principali. Per export massivi conviene paginare con dimensioni ragionevoli (50-100 per pagina) anziché chiedere tutto in un colpo: evita timeout e carico sui sistemi.