Contenuti

Panoramica API

L'API pubblica Le consente di integrare campagne email, iscritti, controlli quota, email transazionali, WhatsApp, Facebook, workspace, allegati, template e statistiche.

URL base: https://app.infomail.ai/api/v1
Autenticazione

Le integrazioni API supportate utilizzano token Bearer generati dalla pagina Token API.

Authorization: Bearer YOUR_API_TOKEN
Importante: Questa documentazione descrive intenzionalmente solo l'accesso API basato su token. 
curl -X GET "https://app.infomail.ai/api/v1/subscribers" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
Controllo funzionalità
  • La maggior parte degli endpoint dati richiede la funzionalità del piano api_access.
  • Gli endpoint WhatsApp richiedono anche whatsapp.
  • Gli endpoint Facebook richiedono anche facebook_ads.
  • Gli endpoint di elenco piani e utilizzo restano disponibili al di fuori del gate api_access.
Gruppi di endpoint
Campagne
MetodoEndpointDescrizione
GET/api/v1/campaignsElenca campagne
POST/api/v1/campaignsCrea campagna
GET/api/v1/campaigns/{id}Mostra campagna
PUT/PATCH/api/v1/campaigns/{id}Aggiorna campagna
DELETE/api/v1/campaigns/{id}Elimina campagna
POST/api/v1/campaigns/{id}/sendInvia campagna
GET/api/v1/campaigns/{id}/statsStatistiche della campagna
GET/api/v1/campaigns/{id}/messagesMessaggi della campagna
GET/api/v1/campaigns/{id}/exportEsportazione CSV campagna
GET/api/v1/stats/campaignsTutte le statistiche della campagna
Iscritti e quota
MetodoEndpointDescrizione
GET/api/v1/subscribersElenca iscritti con campi bounce e abuso
POST/api/v1/subscribersCrea o aggiorna iscritto tramite email
GET/api/v1/subscribers/{id}Mostra iscritto
GET/api/v1/quotaStato della quota attuale
POST/api/v1/quota/checkVerifica se un volume può essere inviato
Controllo transazionale e spam
MetodoEndpointDescrizione
POST/api/v1/transactional/sendInvia email transazionale
GET/api/v1/transactional/{messageId}Stato email transazionale
GET/api/v1/transactional/templates/{id}Dettagli template transazionale
POST/api/v1/spam-check/analyzeAnalisi spam completa
POST/api/v1/spam-check/quickControllo spam rapido
GET/api/v1/spam-check/statusStato del servizio di controllo spam
Workspace, campi opzionali, template e allegati
GruppoEndpoint
Workspace/api/v1/workspaces, /api/v1/workspaces/{id}/users
Campi opzionali/api/v1/optional-fields
Importazione/esportazione template/api/v1/templates/import, /api/v1/templates/{id}/export, /api/v1/templates/{id}/content
Allegati/api/v1/attachments, /api/v1/attachments/download/{storedName}
WhatsApp API
Richiede entrambe le funzionalità del piano api_access e whatsapp.
MetodoEndpointDescrizione
GET/api/v1/whatsapp/templatesElenca template
POST/api/v1/whatsapp/templatesCrea template
GET/api/v1/whatsapp/campaignsElenca campagne
POST/api/v1/whatsapp/campaignsCrea campagna
POST/api/v1/whatsapp/campaigns/{id}/scheduleProgramma campagna
POST/api/v1/whatsapp/campaigns/{id}/sendInvia campagna
POST/api/v1/whatsapp/campaigns/{id}/cancelAnnulla campagna
GET/api/v1/whatsapp/campaigns/{id}/preview-recipientsAnteprima destinatari
GET/api/v1/whatsapp/analyticsAnalisi complessiva
GET/api/v1/whatsapp/analytics/exportEsportazione statistiche
GET/api/v1/whatsapp/analytics/campaigns/{id}Analisi campagna
POST/api/v1/whatsapp/analytics/campaigns/{id}/recalculateRicalcola analisi
POST/api/v1/transactional/whatsapp/sendInvia WhatsApp transazionale
GET/api/v1/transactional/whatsapp/{messageId}Stato WhatsApp transazionale
Facebook API
Richiede entrambe le funzionalità del piano api_access e facebook_ads.
MetodoEndpointDescrizione
GET/api/v1/facebook/audiencesElenca audience
POST/api/v1/facebook/audiencesCrea pubblico
POST/api/v1/facebook/audiences/{id}/syncSincronizza iscritti al pubblico
GET/api/v1/facebook/audiences/{id}/statsStatistiche pubblico
DELETE/api/v1/facebook/audiences/{id}Elimina pubblico
POST/api/v1/facebook/campaigns/{campaignId}/sync-audienceSincronizza il pubblico di una campagna
GET/api/v1/facebook/campaigns/{campaignId}/audiencesPubblici collegati alla campagna
POST/api/v1/facebook/campaigns/{campaignId}/track-conversionTraccia conversione campagna
POST/api/v1/facebook/eventsInvia un evento di conversione
POST/api/v1/facebook/events/batchInvia un gruppo di eventi di conversione
Esempi
Email transazionale
curl -X POST "https://app.infomail.ai/api/v1/transactional/send" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "cliente@example.com",
    "subject": "Conferma ordine #12345",
    "content": "<html><body>Ordine confermato</body></html>",
    "from_email": "ordini@acme.com",
    "from_name": "Acme"
  }'
WhatsApp transazionale
curl -X POST "https://app.infomail.ai/api/v1/transactional/whatsapp/send" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+393331234567",
    "template_id": 12,
    "parameters": {
      "body": ["Mario", "ORD-12345"]
    },
    "reference": "order-12345",
    "idempotency_key": "order-12345-whatsapp"
  }'
Eventi Facebook
curl -X POST "https://app.infomail.ai/api/v1/facebook/events" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "event_name": "Purchase",
    "user_data": {
      "email": "mario@example.com"
    },
    "custom_data": {
      "value": 79.90,
      "currency": "EUR"
    }
  }'