Riferimento API

Account e fatturazione

Leggi utilizzo dell'account, analytics e metadati delle chiavi con una chiave API; le modifiche alla fatturazione e la creazione o revoca delle chiavi richiedono una sessione della dashboard.

Filtra account e fatturazione

GET/account

Chiave API

Recupera account, utilizzo, stato della fatturazione e conteggi del workspace con una chiave API

Equivalente con chiave API del profilo della dashboard: titolare dell'account, utilizzo di destinatari e allegati nel periodo corrente rispetto ai limiti del piano, livello di accesso, riepilogo della reputazione del mittente, stato dell'abbonamento, piani pubblicati e conteggi del workspace. Sola lettura; le modifiche alla fatturazione restano riservate alla sessione.

Richiesta

curl https://sendhq.cc/api/v1/account \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Risposta 200

{
  "user": {},
  "usage": {},
  "access": {},
  "reputation": {},
  "infrastructure": {},
  "billing": {},
  "plans": [],
  "workspace": {
    "mailer": "ses",
    "stats": {}
  }
}

GET/analytics

Chiave API

Recupera le analytics di invio della dashboard per 7, 30 o 90 giorni

Totali di email inviate, ricevute, consegnate, in bounce, bloccate, aperte, cliccate e di segnalazioni di spam per l'intervallo, una timeline giornaliera di invii e ricezioni, i principali domini di invio e gli oggetti con le prestazioni migliori.

Parametri di querydays

Richiesta

curl https://sendhq.cc/api/v1/analytics \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Risposta 200

{
  "window": "30d",
  "days": 30,
  "metrics": {
    "sent": 0,
    "received": 0,
    "bounced": 0,
    "blocked": 0,
    "delivered": 0,
    "opened": 0,
    "clicks": 0,
    "complaints": 0
  },
  "timeline": [],
  "domains": [],
  "topContent": []
}

GET/profile

Sessione del browser

Recupera account, utilizzo e stato degli abbonamenti cumulati

Richiesta

curl https://sendhq.cc/api/v1/profile \
  -X GET \
  -H "Cookie: sendhq_session_v2=…"

Risposta 200

{
  "user": {},
  "usage": {},
  "access": {},
  "reputation": {},
  "billing": {},
  "plans": []
}

POST/billing/checkout

Sessione del browser

Avvia un checkout ospitato per un piano non ancora attivo (livello, classe di messaggi e periodicità di fatturazione)

Richiesta

curl https://sendhq.cc/api/v1/billing/checkout \
  -X POST \
  -H "Cookie: sendhq_session_v2=…" \
  -H "Content-Type: application/json" \
  -d '{"plan_key":"scaleup_marketing_annual"}'

Risposta 200

{
  "url": "https://checkout.example/…",
  "session_id": "…"
}

POST/billing/cancel

Sessione del browser

Annulla l'abbonamento corrente dall'app senza intervenire sul provider

Richiesta

curl https://sendhq.cc/api/v1/billing/cancel \
  -X POST \
  -H "Cookie: sendhq_session_v2=…"

Risposta 200

{
  "ok": true
}

POST/keys

Sessione del browser

Crea una chiave API

Richiesta

curl https://sendhq.cc/api/v1/keys \
  -X POST \
  -H "Cookie: sendhq_session_v2=…" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production"}'

Risposta 201

{
  "id": "key_…",
  "name": "Production",
  "key": "re_…",
  "prefix": "re_…"
}

GET/keys

Chiave API

Elenca i metadati delle chiavi API

Elenca nomi delle chiavi, prefissi non segreti e timestamp dell'ultimo utilizzo. I valori completi delle chiavi non vengono mai restituiti. La creazione e la revoca delle chiavi richiedono una sessione della dashboard.

Richiesta

curl https://sendhq.cc/api/v1/keys \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Risposta 200

{
  "data": [],
  "count": 0
}

DELETE/keys/:id

Sessione del browser

Revoca una chiave API

Richiesta

curl https://sendhq.cc/api/v1/keys/id_value \
  -X DELETE \
  -H "Cookie: sendhq_session_v2=…"

Risposta 200

{
  "ok": true
}