OAuth de servidor a servidor | Documentación | API de búsqueda de subdominios | API WhoisXML

OAuth de servidor a servidor

Utilice OAuth de servidor a servidor para autenticarse con las API WhoisXML al realizar solicitudes de API. Esto se también conocido como OAuth de dos patas, ya que utiliza un flujo de proceso de dos pasos que no requiere la interacción del usuario para autenticación o autorización. Este es el flujo.

  • Su cliente OAuth de servidor a servidor solicita un token de acceso al servidor de autorización de la API WhoisXML.
  • 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 la API WHOIS con el SSO del lado del servidor.

Generar un token de acceso

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

  • El tiempo de vida del token es de 1800 (30 minutos), 3600 (1 hora), 7200 (2 horas) o 10800 segundos (3 horas). Por defecto es 3600 segundos (1 hora).
  • No hay ficha de actualización.
  • Puede generar y utilizar varias fichas de acceso.
  • Cuando se genera la nueva clave API, se invalidan todos los tokens de acceso generados anteriormente.
  • Las fichas de acceso generadas son válidas para cualquier producto al que tenga acceso.

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

Punto final de API

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

Cabeceras

Autorización

Requerida. Clave API codificada en Base64.

Esquema de autenticación: Portador.

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

Parámetros de entrada

grantType

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

Valores aceptables: access_token.

caducaEn

Opcional. El tiempo de vida de la ficha de acceso en segundos.

Valores aceptables: 1800, 3600, 7200, 10800.

Por defecto: 3600.

outputFormat

Opcional. Formato de salida de la respuesta.

Valores aceptados: JSON | XML

Por defecto: JSON

Respuesta

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

Utilice el accessToken de la respuesta para autenticar sus solicitudes a la API. Sustituya el valor resultante en el campo apiKey como lo haría con una clave 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 la API WHOIS cURL con token de acceso

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

Ejemplo de solicitud POST de la API WHOIS 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"
    }'