API-referentie

Account en facturering

Lees accountgebruik, analytics en sleutelmetadata met een API-sleutel; wijzigingen in de facturering en het aanmaken of intrekken van sleutels vereisen een dashboardsessie.

Account en facturering filteren

GET/account

API-sleutel

Account, gebruik, factureringsstatus en aantallen workspaces ophalen met een API-sleutel

De tegenhanger van het dashboardprofiel voor API-sleutels: de accounteigenaar, het gebruik van ontvangers en bijlagen in de huidige periode ten opzichte van de limieten van het abonnement, het toegangsniveau, een samenvatting van de afzenderreputatie, de abonnementsstatus, gepubliceerde abonnementen en aantallen workspaces. Alleen-lezen; wijzigingen in de facturering blijven voorbehouden aan de sessie.

Request

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

200-respons

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

GET/analytics

API-sleutel

Verzendanalytics van het dashboard ophalen voor 7, 30 of 90 dagen

Totalen voor verzonden, ontvangen, afgeleverd, gebounced, geblokkeerd, geopend, geklikt en klachten binnen de periode, een tijdlijn van verzonden/ontvangen per dag, de belangrijkste verzenddomeinen en de best presterende onderwerpen.

Queryparametersdays

Request

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

200-respons

{
  "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

Browsersessie

Account, gebruik en gestapelde abonnementsstatus ophalen

Request

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

200-respons

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

POST/billing/checkout

Browsersessie

Een gehoste checkout starten voor een abonnement dat je nog niet hebt (niveau, berichtklasse en factureringsinterval)

Request

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"}'

200-respons

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

POST/billing/cancel

Browsersessie

Het huidige abonnement in de app opzeggen zonder de provider aan te raken

Request

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

200-respons

{
  "ok": true
}

POST/keys

Browsersessie

Een API-sleutel aanmaken

Request

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

201-respons

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

GET/keys

API-sleutel

Metadata van API-sleutels opvragen

Vraag sleutelnamen, niet-geheime prefixen en tijdstippen van laatste gebruik op. Volledige sleutelwaarden worden nooit teruggegeven. Voor het aanmaken en intrekken van sleutels is een dashboardsessie nodig.

Request

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

200-respons

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

DELETE/keys/:id

Browsersessie

Een API-sleutel intrekken

Request

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

200-respons

{
  "ok": true
}