OAuth de serveur à serveur

Utilisez l'OAuth serveur à serveur pour vous authentifier auprès des API WhoisXML lorsque vous effectuez des requêtes API. Ce procédé est également appelé « OAuth à deux étapes », car il suit un flux en deux étapes qui ne nécessite aucune intervention de l'utilisateur pour l'authentification ou l'autorisation. Voici le déroulement de ce flux.

  • Votre client OAuth serveur à serveur demande un jeton d'accès au serveur d'autorisation de l'API WhoisXML.
  • Votre client utilise le jeton d'accès pour effectuer des requêtes API.

Vous pouvez également consulter ce script sur GitHub pour découvrir un exemple d'utilisation de l'API WHOIS avec l'authentification unique côté serveur.

Générer un jeton d'accès

Utilisez le type d'autorisation pour générer un jeton d'accès. Les caractéristiques de ce type d'autorisation sont les suivantes :

  • La durée de vie du jeton est de 1 800 (30 minutes), 3 600 (1 heure), 7 200 (2 heures) ou 10 800 secondes (3 heures). La valeur par défaut est de 3 600 secondes (1 heure).
  • Il n'y a pas de jeton de rafraîchissement.
  • Vous pouvez générer et utiliser plusieurs jetons d'accès.
  • Lorsque la nouvelle clé API est générée, tous les jetons d'accès générés précédemment sont invalidés.
  • Les jetons d'accès générés sont valables pour tous les produits auxquels vous avez accès.

Veuillez noter que l' accessToken est utilisé à la place de la apiKey dans les requêtes API.

Point de terminaison de l'API

PUBLICATION https://main.whoisxmlapi.com/oauth/token
curl --location 'https://main.whoisxmlapi.com/oauth/token' \
--header 'Authorization: Bearer %base64_encoded_API_key%' \
--header 'Content-Type: application/json' \
--data '{
    "grantType": "access_token",
    "expiresIn": 7200
}'

En-têtes

Autorisation

Obligatoire. Clé API encodée en Base64.

Schéma d'authentification: Bearer.

Obtenez votre clé API personnelle sur la page « Mes produits ».

Paramètres d'entrée

type de subvention

Obligatoire. Le type d'autorisation permettant de générer un jeton d'accès.

Valeurs acceptées : access_token.

expire dans

Facultatif. La durée de validité du jeton d'accès, exprimée en secondes.

Valeurs autorisées : 1800, 3600, 7200, 10800.

Valeur par défaut : 3600.

format de sortie

Facultatif. Format de sortie de la réponse.

Valeurs acceptées : JSON | XML

Par défaut : JSON

Réponse

{
    "accessToken": "G2OIE2AKRCVDYFUJCV5PXXXXXXXXXXXX",
    "expiresIn": 7200
}

Utilisez le accessToken de la réponse pour authentifier vos requêtes API. Remplacez la valeur obtenue par champ comme vous le feriez avec une clé API normale sans OAuth.

Erreurs

{
    "code": 401,
    "messages": "Access restricted. Check the credits balance or enter the correct API key."
}
{
    "code": 422,
    "messages": {
        "grantType": [
            "The selected grant type is invalid."
        ]
    }
}

Exemple de requête GET via l'API WHOIS de cURL avec un jeton d'accès

curl --location 'https://www.whoisxmlapi.com/whoisserver/WhoisService?domainName=google.com' \
--header 'Authorization: Bearer %accessToken%'

Exemple de requête POST à l'API WHOIS via cURL avec un jeton d'accès

curl --location 'https://www.whoisxmlapi.com/whoisserver/WhoisService' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer %accessToken%' \
    --data '{
        "domainName": "google.com"
    }'