Domaines : aide à la configuration
Envoyer les instructions DNS
Envoie par email les enregistrements DNS d'un domaine à la personne qui gère votre DNS : votre équipe IT, une agence, un freelance.
https://g.sendcorex.com/v1/domaincommand: send_dns_instructionsNécessite le scope domain:read sur votre API key.
Jusqu'à 5 appels par minute et par compte. Au-delà, la commande répond RATE_LIMITED.
Pendant une mise à niveau DKIM, l'email contient le nouvel enregistrement (celui qui manque encore), pas l'actuel.
Arguments
domainstringobligatoireLe nom du domaine.
ex. :
"acme.com"emailstringobligatoireLe destinataire des instructions. Jusqu'à 255 caractères.
ex. :
"it@acme.com"
Démarrage rapide
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/domain',
{
commands: [
{
command: "send_dns_instructions",
args: {
domain: "acme.com",
email: "it@acme.com"
}
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);
const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);Réponse
{
"type": "SUCCESS",
"results": [
{
"command": "send_dns_instructions",
"id": "0",
"type": "SUCCESS",
"took_ms": 910,
"data": {
"domain": "acme.com",
"sent_to": "it@acme.com"
}
}
]
}Champs de la réponse
domainLe domaine.
sent_toL'adresse à laquelle l'email a été envoyé.
Ce que contient l'email
EnregistrementsSPF, DKIM, Return-Path et DMARC, avec nom et valeur prêts à copier.
ExpéditeurLe nom de votre compte, pour que la personne sache qui a fait la demande.
Erreurs
Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.
- 401
INVALID_API_KEYL'API key n'existe pas, a été révoquée ou désactivée dans le dashboard.
- 429
RATE_LIMITEDPlus de 15 requêtes/s ou 15 simultanées pour la même IP + API key. Attendez le nombre de secondes indiqué dans Retry-After.
- CMD
MISSING_SCOPEL'API key n'a pas le scope requis par cette commande.
- CMD
INVALID_ARGSUn argument est invalide : `domain` manquant ou mal formé, `key_size` autre que 1024/2048, `email` invalide, une description de plus de 255 caractères…
- CMD
DOMAIN_NOT_FOUNDLe domaine n'est pas sur votre compte.
- CMD
SEND_FAILEDL'email d'instructions n'a pas pu être envoyé. Réessayez.
- CMD
USER_NOT_FOUNDLe compte de l'API key n'existe plus.
- CMD
RATE_LIMITEDCette commande a été appelée trop de fois par votre compte au cours de la dernière minute. Attendez une minute.
- CMD
INTERNALErreur serveur. Le détail n'est écrit que dans le log du serveur.