OAuth de servidor a servidor

Utilice el OAuth de servidor a servidor para autenticarse en las API de WhoisXML al realizar solicitudes a las API. Esto se conoce también como OAuth de dos etapas, ya que utiliza un flujo de proceso de dos pasos que no requiere la intervención del usuario para la autenticación ni la autorización. A continuación se describe el flujo.

  • Su cliente OAuth de servidor a servidor solicita un token de acceso al servidor de autorización de WhoisXML API.
  • Su cliente utiliza el token de acceso para realizar solicitudes a la API.

También puede consultar este script en GitHub para ver un ejemplo de cómo utilizar WHOIS API con el SSO del lado del servidor.

Generar un token de acceso

Utilice el tipo de concesión «accessToken» para generar un token de acceso. Las características de este tipo de concesión son:

  • La duración del token es de 1800 (30 minutos), 3600 (1 hora), 7200 (2 horas) o 10 800 segundos (3 horas). El valor predeterminado es 3600 segundos (1 hora).
  • No hay ningún token de actualización.
  • Puede generar y utilizar varios tokens de acceso.
  • Cuando se genera la nueva clave de API, todos los tokens de acceso generados anteriormente quedan invalidados.
  • Los tokens de acceso generados son válidos para cualquier producto al que tenga acceso.

Tenga en cuenta que el accessToken se utiliza en lugar de la apiKey en las solicitudes a la API.

Endpoint de la API

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

Encabezados

Autorización

Obligatorio. Clave de API codificada en Base64.

Esquema de autenticación: Bearer.

Consiga su clave API personal en la página Mis productos.

Parámetros de entrada

grantType

Obligatorio. El tipo de autorización para generar un token de acceso.

Valores válidos: access_token.

expiresIn

Opcional. La duración del token de acceso, en segundos.

Valores válidos: 1800, 3600, 7200, 10800.

Valor predeterminado: 3600.

outputFormat

Opcional. Formato de salida de la respuesta.

Valores válidos: JSON | XML

Valor predeterminado: JSON

Respuesta

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

Utilice el accessToken de la respuesta para autenticar sus solicitudes a la API. Sustituya el valor resultante en la campo «apiKey» tal y como lo haría con una clave de API normal sin OAuth.

Errores

{
    "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."
        ]
    }
}

Ejemplo de solicitud GET de API WHOIS de cURL con token de acceso

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

Ejemplo de solicitud POST a la API WHOIS de cURL con token de acceso

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