Référence de l’API

Compte et facturation

Lisez l’usage du compte, les analyses et les métadonnées des clés avec une clé API ; les modifications de facturation ainsi que la création ou la révocation de clés exigent une session du tableau de bord.

Filtrer compte et facturation

GET/account

Clé API

Récupérer le compte, l’usage, l’état de facturation et les compteurs de l’espace de travail avec une clé API

Équivalent par clé API du profil du tableau de bord : le propriétaire du compte, l’usage des destinataires et des pièces jointes sur la période en cours par rapport aux limites de la formule, le niveau d’accès, un résumé de la réputation d’expéditeur, l’état de l’abonnement, les formules publiées et les compteurs de l’espace de travail. Lecture seule ; les modifications de facturation restent réservées à la session.

Requête

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

Réponse 200

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

GET/analytics

Clé API

Récupérer les analyses d’envoi du tableau de bord sur 7, 30 ou 90 jours

Totaux des e-mails envoyés, reçus, délivrés, en bounce, bloqués, ouverts, cliqués et des plaintes sur la période, une chronologie quotidienne envoyés/reçus, les principaux domaines d’envoi et les objets les plus performants.

Paramètres de requêtedays

Requête

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

Réponse 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

Session navigateur

Récupérer le compte, l’usage et l’état des abonnements cumulés

Requête

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

Réponse 200

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

POST/billing/checkout

Session navigateur

Démarrer un paiement hébergé pour une formule que vous ne détenez pas encore (palier, catégorie de message et périodicité de facturation)

Requête

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

Réponse 200

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

POST/billing/cancel

Session navigateur

Résilier l’abonnement en cours depuis l’application sans intervenir chez le fournisseur

Requête

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

Réponse 200

{
  "ok": true
}

POST/keys

Session navigateur

Créer une clé API

Requête

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

Réponse 201

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

GET/keys

Clé API

Lister les métadonnées des clés API

Liste les noms des clés, leurs préfixes non secrets et l’horodatage de leur dernière utilisation. Les valeurs complètes des clés ne sont jamais renvoyées. La création et la révocation de clés exigent une session du tableau de bord.

Requête

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

Réponse 200

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

DELETE/keys/:id

Session navigateur

Révoquer une clé API

Requête

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

Réponse 200

{
  "ok": true
}