Guida pratica all'API REST di AILabsAudit: automatizza i tuoi audit di visibilità IA

<p class="lead">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.</p> <h2>Perché integrare l'API REST di AILabsAudit?</h2> <p>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:</p> <ul> <li><strong>Automazione completa</strong>: avvia audit pianificati tramite cron job o workflow CI/CD</li> <li><strong>Integrazione nella dashboard</strong>: visualizza i punteggi di visibilità IA direttamente nel tuo strumento di reporting</li> <li><strong>Avvisi personalizzati</strong>: rileva i cali di visibilità e notifica automaticamente i tuoi team</li> <li><strong>Report personalizzati</strong>: combina i dati di AILabsAudit con le tue metriche per report arricchiti</li> <li><strong>Sincronizzazione CRM</strong>: collega i dati degli audit alle schede dei tuoi clienti nel tuo CRM</li> </ul> <h2>Cosa puoi fare con l'API</h2> <h3>Gestione dei clienti</h3> <p>Accedi all'intero portafoglio clienti tramite l'endpoint <code>/api/v1/clients</code>. Recupera dettagli, contatti, concorrenti e la vista 360° completa per ogni cliente.</p> <h3>Audit e risultati</h3> <p>Avvia nuovi audit programmaticamente con <code>POST /api/v1/audits/launch</code>, segui il loro avanzamento e recupera risultati dettagliati: punteggi di visibilità, performance dei modelli IA, trend e confronti.</p> <h3>Report PDF</h3> <p>Scarica i report PDF premium tramite <code>GET /api/v1/reports/{id}/download</code> per integrarli nei tuoi flussi di consegna automatizzati ai clienti.</p> <h3>Analytics e portafoglio</h3> <p>Accedi ad analytics avanzate: panoramica del portafoglio, classifica di visibilità, distribuzione dei punteggi. Perfetto per costruire dashboard di monitoraggio multi-cliente.</p> <h2>Avvio rapido in 3 passaggi</h2> <h3>Passaggio 1: crea la tua chiave API</h3> <p>Vai su <a href="/account/api-integrations"><strong>Account → API & Integrations</strong></a> e crea una nuova chiave. Inizierà con <code>aila_</code>.</p> <h3>Passaggio 2: testa la connessione</h3> <div class="callout callout-info"> <h4>Prima richiesta</h4> <pre><code>curl -H "X-Api-Key: aila_your_key" https://ailabsaudit.com/api/v1/clients</code></pre> <p>Se vedi l'elenco dei tuoi clienti in JSON, tutto funziona!</p> </div> <h3>Passaggio 3: esplora gli endpoint</h3> <p>Consulta il <a href="/tutorial/en/rest-api"><strong>tutorial completo dell'API REST</strong></a> per scoprire i 8 gruppi di endpoint, oppure esplora direttamente la <a href="/api/v1/docs"><strong>documentazione Swagger</strong></a>.</p> <h2>Pattern di integrazione comuni</h2> <h3>Audit pianificati automaticamente</h3> <p>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.</p> <pre><code># 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"]}) </code></pre> <h3>Incorporamento nella dashboard</h3> <p>Integra i punteggi di visibilità nella tua dashboard chiamando l'endpoint analytics:</p> <pre><code>scores = requests.get(f"{BASE}/analytics/leaderboard", headers=headers).json() # Visualizza nella tua interfaccia</code></pre> <h3>Avvisi sui cali di visibilità</h3> <p>Confronta i punteggi tra due audit successivi e invia un avviso (email, Slack) se un cliente perde più di 10 punti:</p> <pre><code>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</code></pre> <h2>Best practice</h2> <h3>Rispetta il rate limiting</h3> <p>L'API consente <strong>60 richieste al minuto</strong> per chiave. Spazia le tue chiamate e implementa un backoff esponenziale per gli errori 429. Controlla gli header <code>X-RateLimit-*</code> per monitorare il tuo utilizzo.</p> <h3>Metti in cache le risposte</h3> <p>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.</p> <h3>Gestisci gli errori correttamente</h3> <p>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).</p> <h3>Proteggi la tua chiave</h3> <p>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.</p> <h2>Risorse utili</h2> <div class="info-box" style="background: linear-gradient(135deg, #10b98115 0%, #3b82f615 100%); border-left: 4px solid #10b981; padding: 20px; margin: 2rem 0; border-radius: 0 12px 12px 0;"> <h4 style="margin-top: 0; color: #1e293b;">Vai oltre</h4> <p style="margin-bottom: 1rem;">Esplora queste risorse per padroneggiare l'API REST:</p> <ul style="margin: 0;"> <li><a href="/tutorial/en/rest-api"><strong>Tutorial completo dell'API REST</strong></a> — Guida passo passo con esempi di codice</li> <li><a href="/api/v1/docs"><strong>Documentazione Swagger</strong></a> — Riferimento interattivo per tutti gli endpoint</li> <li><a href="/glossaire/it/api-rest"><strong>Glossario: REST API</strong></a> — Definizione e concetti chiave</li> <li><a href="/tutorial/en/mcp-guide"><strong>Guida MCP</strong></a> — Collega il tuo assistente IA direttamente a AILabsAudit</li> </ul> </div> <h2>FAQ</h2> <div class="faq-section"> <div class="faq-item"> <h4>Quale abbonamento è necessario per accedere all'API REST?</h4> <p>L'API REST è disponibile con i piani Enterprise e Partner. I piani Free e standard non includono l'accesso API. <a href="/partner-request">Richiedi l'accesso partner</a> per iniziare.</p> </div> <div class="faq-item"> <h4>L'API REST usa le stesse chiavi di MCP?</h4> <p>Sì, è la stessa chiave API (formato <code>aila_...</code>). Puoi usarla sia per le chiamate REST che per le connessioni MCP. Creala da <a href="/account/api-integrations">API & Integrations</a>.</p> </div> <div class="faq-item"> <h4>Qual è il limite di richieste?</h4> <p>60 richieste al minuto per chiave API. Le intestazioni di risposta (<code>X-RateLimit-Remaining</code>) indicano il tuo utilizzo in tempo reale.</p> </div> <div class="faq-item"> <h4>Posso avviare audit tramite l'API?</h4> <p>Sì, l'endpoint <code>POST /api/v1/audits/launch</code> permette di avviare audit programmaticamente. Puoi stimare il costo in crediti in anticipo e monitorare l'avanzamento dell'audit.</p> </div> <div class="faq-item"> <h4>Esiste un SDK ufficiale?</h4> <p>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.</p> </div> </div> <h2>Conclusione</h2> <p>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.</p> <p><strong>Pronto ad automatizzare?</strong></p> <div class="cta-box"> <a href="/account/api-integrations" class="btn btn-primary btn-lg">Crea la mia chiave API</a> <a href="/tutorial/en/rest-api" class="btn btn-outline-primary btn-lg">Leggi il tutorial completo</a> </div>