Server-zu-Server-OAuth

Verwenden Sie Server-zu-Server-OAuth, um sich bei der Übermittlung von API-Anfragen bei WhoisXML-APIs zu authentifizieren. Dies wird auch als „Two-Legged OAuth“ bezeichnet, da es einen zweistufigen Ablauf nutzt, der keine Benutzerinteraktion für die Authentifizierung oder Autorisierung erfordert. Hier ist der Ablauf.

  • Ihr Server-zu-Server-OAuth-Client fordert ein Zugriffstoken vom WhoisXML-API-Autorisierungsserver an.
  • Ihr Kunde verwendet das Zugriffstoken, um API-Anfragen zu stellen.

Sie können sich dieses Skript auch auf GitHub ansehen, um ein Beispiel für die Verwendung der WHOIS-API mit serverseitigem SSO zu erhalten.

Erstellen Sie ein Zugriffstoken

Verwenden Sie das „accessToken“ Grant-Typ, um ein Zugriffstoken zu generieren. Die Merkmale dieses Grant-Typs sind:

  • Die Gültigkeitsdauer des Tokens beträgt 1800 (30 Minuten), 3600 (1 Stunde), 7200 (2 Stunden) oder 10800 Sekunden (3 Stunden). Der Standardwert beträgt 3600 Sekunden (1 Stunde).
  • Es liegt kein Aktualisierungstoken vor.
  • Sie können mehrere Zugriffstoken generieren und verwenden.
  • Wenn der neue API-Schlüssel generiert wird, werden alle zuvor generierten Zugriffstoken ungültig.
  • Die generierten Zugriffstoken gelten für alle Produkte, auf die Sie Zugriff haben.

Bitte beachten Sie, dass das generierte accessToken anstelle des apiKey in API-Anfragen verwendet wird.

API-Endpunkt

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

Überschriften

Genehmigung

Erforderlich: Base64-kodierter API-Schlüssel.

Authentifizierungsschema: Bearer.

Rufen Sie Ihren persönlichen API-Schlüssel auf der Seite „Meine Produkte “ ab.

Eingabeparameter

Förderart

Erforderlich. Die Berechtigungsart zum Generieren eines Zugriffstokens.

Zulässige Werte: access_token.

läuft ab in

Optional. Die Gültigkeitsdauer des Zugriffstokens in Sekunden.

Zulässige Werte: 1800, 3600, 7200, 10800.

Standardwert: 3600.

Ausgabeformat

Optional. Ausgabeformat der Antwort.

Zulässige Werte: JSON | XML

Standard: JSON

Antwort

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

Verwenden Sie das accessToken in der Antwort, um Ihre API-Anfragen zu authentifizieren. Setzen Sie den resultierenden Wert in den apiKey Feld ein, wie Sie es bei einem normalen API-Schlüssel ohne OAuth tun würden.

Fehler

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

Beispiel für eine GET-Anfrage an die cURL-WHOIS-API mit Zugriffstoken

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

Beispiel für eine cURL-POST-Anfrage an die WHOIS-API mit Zugriffstoken

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