Premiers pas

Créer une clé API

L'envoi et la gestion utilisent une clé. La lecture des e-mails en utilise une autre, créée ailleurs. Choisissez celle qui correspond à ce que vous construisez.

De quelle clé avez-vous besoin ?

mail.sendcorex.comgraph.sendcorex.com

Mail & Graph

Envoyer et gérer

Pour envoyer des e-mails et pour tout le reste de l'API : domaines, contacts, suivi, expéditeurs et logs.

Créée dans

Dashboard, page Developer

Ouvrir la page Developer
g.sendcorex.comUne par compte

Lire les e-mails

Lire une boîte mail

Pour lire, rechercher et organiser les e-mails d'un compte e-mail.

Créée dans

Webmail, Paramètres de chaque compte e-mail

Ouvrir Webmail

Mail & Graph

Envoyer et gérer

Une clé de la page Developer fonctionne sur mail.sendcorex.com et graph.sendcorex.com.

  1. 1

    Ouvrez la page Developer

    Connectez-vous sur app.sendcorex.com et allez sur la page Developer du dashboard.

    Ouvrir la page Developer
  2. 2

    Créez une clé

    Générez-y une nouvelle clé et copiez-la. Conservez-la en lieu sûr.

    Créer une clé API
  3. 3

    Envoyez-la avec chaque requête

    Passez-la dans l'en-tête Authorization sur mail.sendcorex.com et graph.sendcorex.com.

En-tête de requête
Authorization: Bearer YOUR_API_KEY

Lire les e-mails

Lire une boîte mail

Ces clés sont créées dans Webmail, une par compte e-mail, et utilisées sur g.sendcorex.com.

  1. 1

    Ouvrir Webmail

    Allez sur webmail.sendcorex.com et connectez-vous avec le compte e-mail que vous voulez lire.

    Ouvrir Webmail
  2. 2

    Allez dans Paramètres

    Ouvrez la section Paramètres de ce compte e-mail.

  3. 3

    Générez la clé

    Créez-y la clé API et copiez-la. Chaque compte e-mail a la sienne.

Première requête
curl -s https://g.sendcorex.com/v1 \
  -H "Authorization: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"commands":[{"command":"list_folders"}]}'
Renouveler le token
curl -s https://g.sendcorex.com/v1/token/refresh \
  -H "Content-Type: application/json" \
  -d "{\"refresh_token\":\"$REFRESH\"}"

Envoyez le token sous la forme Authorization: <token> ou Authorization: Bearer <token>. Les tokens commencent par S.C.G. et le refresh token par R.S.C.G.

Une boîte mail par clé

La clé détermine les e-mails de qui vous lisez. Aucun argument de requête ne peut choisir un autre propriétaire.

Les tokens expirent

Un token expiré renvoie TOKEN_EXPIRED. Renouvelez la paire avec Refresh Token. Le refresh token utilisé cesse aussitôt de fonctionner.

Clés révoquées

Un token est mis en cache jusqu'à 1 heure : un token révoqué peut donc fonctionner encore jusqu'à l'expiration de ce cache.

Rate limit

15 requêtes par seconde et 15 simultanées, par IP et boîte mail. Au-delà, vous recevez 429 RATE_LIMITED avec un en-tête Retry-After.

Erreurs d'authentification

Ce que renvoie l'API de lecture d'e-mails quand la clé pose problème.

CodeHTTPQuand
MISSING_AUTH_HEADER401La requête n'a pas d'en-tête Authorization.
INVALID_TOKEN401Format incorrect, token inconnu ou révoqué.
TOKEN_EXPIRED401Le token a expiré. Utilisez le refresh token.
RATE_LIMITED429Plus de 15 requêtes par seconde ou 15 en cours.
AUTH_UNAVAILABLE503L'authentification est temporairement indisponible.