Server-to-Server OAuth | Dokumentation | Reverse IP/DNS API | WhoisXML API

Server-zu-Server OAuth

Verwenden Sie Server-to-Server OAuth, um sich bei API-Anfragen mit WhoisXML-APIs zu authentifizieren. Dies wird auch als OAuth mit zwei Beinen bekannt, da es einen zweistufigen Prozessablauf verwendet, der keine Benutzerinteraktion für Authentifizierung oder Autorisierung erfordert. Hier ist der Ablauf.

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

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

Generieren Sie ein Zugriffstoken

Verwenden Sie den accessToken um ein Zugriffstoken zu erzeugen. Die Funktionen dieses Grant-Typs sind:

  • Die Lebensdauer des Tokens beträgt 1800 (30 Minuten), 3600 (1 Stunde), 7200 (2 Stunden) oder 10800 Sekunden (3 Stunden). Die Voreinstellung ist 3600 Sekunden (1 Stunde).
  • Es gibt kein Aktualisierungs-Token.
  • Sie können mehrere Zugriffstoken erstellen und verwenden.
  • Wenn der neue API-Schlüssel generiert wird, werden alle zuvor generierten Zugriffstoken ungültig.
  • Die generierten Zugriffstoken sind für jedes Produkt gültig, auf das Sie Zugriff haben.

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

API-Endpunkt

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

Kopfzeilen

Autorisierung

Erforderlich. Base64-kodierter API-Schlüssel.

Authentifizierungsschema: Überbringer.

Sie erhalten Ihren persönlichen API-Schlüssel auf der Seite Meine Produkte.

Eingabe-Parameter

grantType

Erforderlich. Die Art der Gewährung zur Erstellung eines Zugriffstokens.

Akzeptierte Werte: access_token.

abläuftIn

Optional. Die Lebensdauer des Zugriffstokens in Sekunden.

Akzeptable Werte: 1800, 3600, 7200, 10800.

Standardwert: 3600.

outputFormat

Optional. Format der Antwortausgabe.

Akzeptierte Werte: JSON | XML

Standard: JSON

Antwort

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

Verwenden Sie den accessToken Wert in der Antwort, um Ihre API-Anfragen zu authentifizieren. Ersetzen Sie den resultierenden Wert in der Datei apiSchlüssel Feld ein, wie Sie es mit 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 einer cURL WHOIS API GET-Anfrage mit Zugriffstoken

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

Beispiel einer cURL WHOIS API POST-Anfrage mit Zugriffstoken

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