Vuoi automatizzare i tuoi audit di visibilità IA, integrare i risultati nella tua dashboard interna o collegare AILabsAudit ai tuoi strumenti esistenti? L'API REST v1 è pensata proprio per questo. Questa guida pratica ti accompagna dalla tua prima richiesta ai pattern di integrazione avanzati.
Perché integrare l'API REST di AILabsAudit?
L'interfaccia web di AILabsAudit è ideale per l'uso manuale, ma ha i suoi limiti quando gestisci decine di clienti o devi automatizzare i flussi di lavoro. L'API REST apre possibilità che l'interfaccia non può offrire:
- Automazione completa: avvia audit pianificati tramite cron job o workflow CI/CD
- Integrazione nella dashboard: visualizza i punteggi di visibilità IA direttamente nel tuo strumento di reporting
- Avvisi personalizzati: rileva i cali di visibilità e notifica automaticamente i tuoi team
- Report personalizzati: combina i dati di AILabsAudit con le tue metriche per report arricchiti
- Sincronizzazione CRM: collega i dati degli audit alle schede dei tuoi clienti nel tuo CRM
Cosa puoi fare con l'API
Gestione dei clienti
Accedi all'intero portafoglio clienti tramite l'endpoint /api/v1/clients. Recupera dettagli, contatti, concorrenti e la vista 360° completa per ogni cliente.
Audit e risultati
Avvia nuovi audit programmaticamente con POST /api/v1/audits/launch, segui il loro avanzamento e recupera risultati dettagliati: punteggi di visibilità, performance dei modelli IA, trend e confronti.
Report PDF
Scarica i report PDF premium tramite GET /api/v1/reports/{id}/download per integrarli nei tuoi flussi di consegna automatizzati ai clienti.
Analytics e portafoglio
Accedi ad analytics avanzate: panoramica del portafoglio, classifica di visibilità, distribuzione dei punteggi. Perfetto per costruire dashboard di monitoraggio multi-cliente.
Avvio rapido in 3 passaggi
Passaggio 1: crea la tua chiave API
Vai su Account → API & Integrations e crea una nuova chiave. Inizierà con aila_.
Passaggio 2: testa la connessione
Prima richiesta
curl -H "X-Api-Key: aila_your_key" https://ailabsaudit.com/api/v1/clients
Se vedi l'elenco dei tuoi clienti in JSON, tutto funziona!
Passaggio 3: esplora gli endpoint
Consulta il tutorial completo dell'API REST per scoprire i 8 gruppi di endpoint, oppure esplora direttamente la documentazione Swagger.
Pattern di integrazione comuni
Audit pianificati automaticamente
Il caso d'uso più popolare: un cron job che avvia un audit per ogni cliente a intervalli regolari (settimanale o mensile), recupera i risultati e li memorizza nel tuo database.
# Esempio: audit mensile per tutti i clienti
import requests
API_KEY = "aila_your_key"
BASE = "https://ailabsaudit.com/api/v1"
headers = {"X-Api-Key": API_KEY}
clients = requests.get(f"{BASE}/clients", headers=headers).json()
for client in clients["data"]:
requests.post(f"{BASE}/audits/launch",
headers=headers,
json={"client_id": client["id"]})
Incorporamento nella dashboard
Integra i punteggi di visibilità nella tua dashboard chiamando l'endpoint analytics:
scores = requests.get(f"{BASE}/analytics/leaderboard", headers=headers).json()
# Visualizza nella tua interfaccia
Avvisi sui cali di visibilità
Confronta i punteggi tra due audit successivi e invia un avviso (email, Slack) se un cliente perde più di 10 punti:
audit_history = requests.get(
f"{BASE}/audits?client_id=42&per_page=2",
headers=headers
).json()
# Confronta i punteggi e invia un avviso se necessario
Best practice
Rispetta il rate limiting
L'API consente 60 richieste al minuto per chiave. Spazia le tue chiamate e implementa un backoff esponenziale per gli errori 429. Controlla gli header X-RateLimit-* per monitorare il tuo utilizzo.
Metti in cache le risposte
I dati degli audit non cambiano di frequente. Metti in cache le risposte (Redis, file locale) da 1 a 24 ore per ridurre le chiamate API e migliorare le prestazioni della tua applicazione.
Gestisci gli errori correttamente
L'API restituisce codici HTTP standard e messaggi di errore JSON. Gestisci almeno i casi 401 (chiave non valida), 429 (rate limit) e 500 (errore del server).
Proteggi la tua chiave
Conserva la tua chiave API in una variabile d'ambiente, mai nel codice sorgente. Usa chiavi diverse per ambiente (dev/produzione) e revoca immediatamente una chiave compromessa.
Risorse utili
Vai oltre
Esplora queste risorse per padroneggiare l'API REST:
- Tutorial completo dell'API REST — Guida passo passo con esempi di codice
- Documentazione Swagger — Riferimento interattivo per tutti gli endpoint
- Glossario: REST API — Definizione e concetti chiave
- Guida MCP — Collega il tuo assistente IA direttamente a AILabsAudit
FAQ
Quale abbonamento è necessario per accedere all'API REST?
L'API REST è disponibile con i piani Enterprise e Partner. I piani Free e standard non includono l'accesso API. Richiedi l'accesso partner per iniziare.
L'API REST usa le stesse chiavi di MCP?
Sì, è la stessa chiave API (formato aila_...). Puoi usarla sia per le chiamate REST che per le connessioni MCP. Creala da API & Integrations.
Qual è il limite di richieste?
60 richieste al minuto per chiave API. Le intestazioni di risposta (X-RateLimit-Remaining) indicano il tuo utilizzo in tempo reale.
Posso avviare audit tramite l'API?
Sì, l'endpoint POST /api/v1/audits/launch permette di avviare audit programmaticamente. Puoi stimare il costo in crediti in anticipo e monitorare l'avanzamento dell'audit.
Esiste un SDK ufficiale?
Non ancora, ma il tutorial dell'API REST fornisce esempi completi in Python, JavaScript e PHP che puoi usare come base. Un SDK ufficiale è in sviluppo.
Conclusione
L'API REST di AILabsAudit è la chiave per passare dall'uso manuale alla piena automazione dei tuoi audit di visibilità IA. Che tu voglia pianificare audit ricorrenti, integrare i punteggi nella tua dashboard o creare avvisi personalizzati, l'API ti offre gli strumenti per farlo.
Pronto ad automatizzare?
Agenzie, consulenti e team interni: confrontate le risposte ai vostri scenari, nelle lingue e con i modelli selezionati. La nostra infrastruttura, i vostri scenari, la vostra esperienza.