Référence de l’API

Domaines de courriel

Vérifier des domaines d’envoi pour le courriel.

get/v1/email-domains

Lister les domaines d’envoi

Permissionemail_domains:rSDK Node.jshonkio.domains.list()

Nécessite email_domains:r.

Réponses

401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data, error } = await honkio.domains.list()
if (error) throw new Error(error.message)
for (const d of data.data) console.log(d.domain, d.status)

curl https://api.honkio.ca/v1/email-domains \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

post/v1/email-domains

Ajouter un domaine d’envoi

Permissionemail_domains:wSDK Node.jshonkio.domains.create()

Nécessite email_domains:w.

Corps de la requête

Le domaine d’où envoyer.

Champ	Type	Description
`domain`obligatoire	string	Un domaine ou un sous-domaine que vous contrôlez, par exemple mail.yourdomain.ca. Publiez les enregistrements DNS indiqués dans la réponse, puis vérifiez-le. Au moins 1 caractères Au plus 253 caractères

Réponses

401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data: domain, error } = await honkio.domains.create({ domain: 'yourdomain.ca' })
if (error) throw new Error(error.message)
for (const record of domain.records) console.log(record)

curl -X POST https://api.honkio.ca/v1/email-domains \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "yourdomain.ca"
  }'

get/v1/email-domains/{id}

Obtenir un domaine d’envoi

Permissionemail_domains:rSDK Node.jshonkio.domains.get()

Nécessite email_domains:r.

Paramètres

Paramètre	Type	Description
`id`obligatoirechemin	string

Réponses

401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data, error } = await honkio.domains.get('DOMAIN_ID')
if (error) throw new Error(error.message)
console.log(data.status, data.records)

curl https://api.honkio.ca/v1/email-domains/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

patch/v1/email-domains/{id}

Modifier le suivi des ouvertures et des clics ou la réception d’un domaine d’envoi

Permissionemail_domains:mSDK Node.jshonkio.domains.update()

Nécessite email_domains:m.

Paramètres

Paramètre	Type	Description
`id`obligatoirechemin	string

Corps de la requête

Les réglages à modifier : au moins un de open_tracking, click_tracking ou receiving.

Champ	Type	Description
`open_tracking`	boolean	Suit les ouvertures des courriels de ce domaine. null rétablit la valeur par défaut de la plateforme. Peut être null
`click_tracking`	boolean	Suit les clics dans les courriels de ce domaine. null rétablit la valeur par défaut de la plateforme. Peut être null
`receiving`	boolean	Reçoit des courriels à ce domaine. Le domaine doit d’abord être vérifié pour l’envoi ; la réponse ajoute l’enregistrement MX de réception à publier.

Réponses

200Le domaine mis à jour, avec les enregistrements DNS à publier (le MX de réception tant que la réception est activée).

Champ	Type	Description
`id`obligatoire	string
`domain`obligatoire	string
`status`obligatoire	string	Une valeur parmi : pending \| verifying \| verified \| failed \| temporarily_failed
`region`obligatoire	string
`verified_at`obligatoire	string	Format : date-time Peut être null
`last_checked_at`obligatoire	string	Format : date-time Peut être null
`failure_reason`obligatoire	string	Peut être null
`revalidation_failed_at`obligatoire	string	Format : date-time Peut être null
`open_tracking`obligatoire	boolean	Peut être null
`click_tracking`obligatoire	boolean	Peut être null
`receiving_status`obligatoire	string	Une valeur parmi : off \| pending \| verified \| failed
`receiving_requested_at`obligatoire	string	Format : date-time Peut être null
`receiving_verified_at`obligatoire	string	Format : date-time Peut être null
`receiving_failure_reason`obligatoire	string	Peut être null
`receiving_revalidation_failed_at`obligatoire	string	Format : date-time Peut être null
`receiving_last_checked_at`obligatoire	string	Moment de la dernière vérification distincte du MX de réception ; last_checked_at date la vérification d’envoi. Format : date-time Peut être null
`receiving_warning`obligatoire	string	apex_mx lorsque la réception est activée sur ce qui est vraisemblablement un apex enregistrable : un MX à cet endroit remplace la réception habituelle du courriel du domaine lui-même. Une valeur parmi : apex_mx Peut être null
`created_at`obligatoire	string	Format : date-time
`records[]`obligatoire	object[]
`type`obligatoire	string	Une valeur parmi : TXT \| MX
`name`obligatoire	string
`value`obligatoire	string
`purpose`obligatoire	string	Une valeur parmi : dkim \| mail_from \| spf \| dmarc_recommended \| inbound
`receiving_missing[]`obligatoire	object[]	L’enregistrement MX de réception, lorsque cette requête vient d’activer la réception et qu’il n’est pas encore publié ; [] sinon. Il s’agit d’une simple consultation : c’est POST /v1/email-domains/{id}/verify qui fait évoluer receiving_status.
`record`obligatoire	string
`expected`obligatoire	string

401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
403ACCOUNT_NOT_VERIFIED : l’activation de la réception pour un domaine de production nécessite un numéro mobile du propriétaire vérifié. La désactivation de la réception et tous les autres champs ne sont pas touchés. Également FORBIDDEN lorsque la clé n’a pas la permission requise par cette opération, ou que le compte est suspendu ou fermé.Le corps d’erreur standard.
404NOT_FOUND : aucune ressource correspondante sur ce compte.Le corps d’erreur standard.
409RECEIVING_REQUIRES_VERIFIED_DOMAIN : la réception ne peut être activée que pour un domaine vérifié pour l’envoi.Le corps d’erreur standard.
422VALIDATION_ERROR : la requête n’a pas passé la validation ; details indique les champs en cause.Le corps d’erreur standard.
429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data, error } = await honkio.domains.update('DOMAIN_ID', { clickTracking: false, receiving: true })
if (error) throw new Error(error.message)
console.log(data.receiving_status)

curl -X PATCH https://api.honkio.ca/v1/email-domains/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "click_tracking": false,
    "receiving": true
  }'

delete/v1/email-domains/{id}

Supprimer un domaine d’envoi

Permissionemail_domains:dSDK Node.jshonkio.domains.remove()

Nécessite email_domains:d.

Paramètres

Paramètre	Type	Description
`id`obligatoirechemin	string

Réponses

401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { error } = await honkio.domains.remove('DOMAIN_ID')
if (error) throw new Error(error.message)

curl -X DELETE https://api.honkio.ca/v1/email-domains/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

post/v1/email-domains/{id}/verify

Vérifier de nouveau le DNS et l’état de la vérification SES

Permissionemail_domains:wSDK Node.jshonkio.domains.verify()

Nécessite email_domains:w.

Paramètres

Paramètre	Type	Description
`id`obligatoirechemin	string

Réponses

200Le résultat de la vérification. missing liste les enregistrements d’envoi introuvables ; receiving_missing, l’enregistrement MX de réception lorsque la réception est activée et qu’il n’est pas publié.

Champ	Type	Description
`id`obligatoire	string
`status`obligatoire	string	Une valeur parmi : pending \| verifying \| verified \| failed \| temporarily_failed
`verified`obligatoire	boolean
`missing[]`obligatoire	object[]
`record`obligatoire	string
`expected`obligatoire	string
`ses_status`obligatoire	string	Peut être null
`mail_from_status`obligatoire	string	Peut être null
`receiving_status`obligatoire	string	Une valeur parmi : off \| pending \| verified \| failed
`receiving_missing[]`obligatoire	object[]
`record`obligatoire	string
`expected`obligatoire	string
`receiving_warning`obligatoire	string	apex_mx lorsque la réception est activée sur ce qui est vraisemblablement un apex enregistrable : un MX à cet endroit remplace la réception habituelle du courriel du domaine lui-même. Une valeur parmi : apex_mx Peut être null

401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
404NOT_FOUND : aucune ressource correspondante sur ce compte.Le corps d’erreur standard.
429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data, error } = await honkio.domains.verify('DOMAIN_ID')
if (error) throw new Error(error.message)
console.log(data.verified, data.missing)

curl -X POST https://api.honkio.ca/v1/email-domains/ID/verify \
  -H "Authorization: Bearer mk_live_YOUR_KEY"