Notice: We're retiring Works with Nest. See the home page for more information.
Google is committed to advancing racial equity for Black communities. See how.
Diese Seite wurde von der Cloud Translation API übersetzt.
Switch to English

Autorisierungsreferenz

Autorisierungscode anfordern

Abhängig vom Anforderungstyp implementieren wir unterschiedliche Codelängen und TTL-Werte (Time-to-Live):

Fließen TTL Codelänge
Netz 10 Minuten 16 Zeichen
STIFT 48 Stunden 8 Charaktere

Parameter

Die in der Nest-API unterstützten Autorisierungsparameter sind:

Name Art Erforderlich Beschreibung
client_id Zeichenfolge Ja Verfügbar auf der Seite OAuth-Clients.
redirect_uri Zeichenfolge Nein Verwenden Sie diese Option, um den gewünschten Umleitungs-URI anzugeben, wenn für Ihren Client mehrere Umleitungs-URIs konfiguriert sind. Lassen Sie es aus, um Ihren Standard-Umleitungs-URI zu verwenden.

Fügen Sie keine anderen Parameter in den Parameter redirect_uri selbst ein. Er sollte genau mit einem für Ihren Client konfigurierten Umleitungs-URI übereinstimmen.
state Zeichenfolge Ja Verwenden Sie diese Option, um einen nicht zu erratenden Wert für die Bekämpfung von CSRF-Angriffen anzugeben. Verwenden Sie andernfalls den Standardwert STATE .

PIN-basierte Autorisierungsfehlermeldungen

Die folgenden Fehlermeldungen können Benutzern bei PIN-basierten Autorisierungscode-Anforderungen angezeigt werden:

Benutzerfehlermeldung Erläuterung
Fehlende Client-ID oder Statusparameter. In der Autorisierungs-URL fehlt entweder der Parameter client_id oder state oder beides. Stellen Sie sicher, dass die übergebene Autorisierungs-URL vollständig und korrekt ist.
Hoppla! Wir haben einen Fehler festgestellt. Bitte versuche es erneut. Dieser Fehler tritt aus folgenden Gründen auf:
  • Der Nest-Service ist ausgefallen. Warten Sie, bis der Nest-Dienst wiederhergestellt ist.
  • Für die angegebene client_id existiert kein Client. Stellen Sie sicher, dass die übergebene Autorisierungs-URL die richtige client_id .
Die Verbindung zum Firmennamen ist derzeit nicht verfügbar. Bitte kontaktieren Sie Nest für weitere Informationen. Der Client hat das Benutzerkontingent überschritten. Senden Sie Ihren Client zur Überprüfung, um weitere Benutzer hinzuzufügen.

URI-basierte Autorisierungsfehlerantworten umleiten

Inhaltstyp für alle Antworten: application/json .

Fehlende erforderliche Parameter

Einzelheiten
HTTP-Statuscode 400 schlechte Anfrage
Körper {
"error":"oauth2_error",
"error_description":"missing required parameters: PARAM_NAME "
}
Erläuterung Ein erforderlicher Parameter, PARAM_NAME , fehlt in der Autorisierungscode-Anforderung.

redirect_uri nicht vorregistriert

Einzelheiten
HTTP-Statuscode 400 schlechte Anfrage
Körper {
"error":"input_data_error",
"error_description":"redirect_uri not pre-registered"
}
Erläuterung Der in der Zugriffstokenanforderung verwendete Parameter redirect_uri stimmt mit keinem der für Ihren Client konfigurierten Umleitungs-URIs überein.

Zugriffstokenanforderung

Wir empfehlen Ihnen, diesen OAuth-Standard einzuhalten, der eine erhöhte Sicherheit bietet, indem Sie die Client-Anmeldeinformationen in den Anforderungshauptteil aufnehmen. Anrufe mit Client-Anmeldeinformationen im Header funktionieren weiterhin, werden jedoch nicht empfohlen.

Die Zugriffstokenanforderung erfolgt in Form einer HTTP-POST-Anforderung.

Parameter

Name Art Erforderlich Beschreibung
code Zeichenfolge Ja Der Autorisierungscode, der übergeben wird, nachdem Ihr Kunde zugestimmt hat, Ihrer App Zugriff auf Nest-Daten zu gewähren. Dieser Wert wird durch eine erfolgreiche Autorisierungscode-Anforderung bereitgestellt.

Erfahren Sie, wie Sie die Autorisierung einrichten
client_id Zeichenfolge Ja Verfügbar auf der Seite OAuth-Clients.
client_secret Zeichenfolge Ja Verfügbar auf der Seite OAuth-Clients. kann auch als Anwendungsschlüssel bezeichnet werden.
grant_type Zeichenfolge Ja Muss diese Zeichenfolge sein: authorization_code

Antwort

Inhaltstyp für alle Antworten: application/json

HTTP-Statuscode Beschreibung Körper
200 OK Zugriffstoken wird zurückgegeben. Verwenden Sie das Zugriffstoken bei Aufrufen des Nest-Dienstes. LONG ist die Anzahl der Sekunden, bis der Token abläuft. {
"access_token":"STRING",
"expires_in":LONG
}

Zugriffstoken-Lebensdauer

Wir unterstützen keine Aktualisierungstoken , da Zugriffstoken praktisch nicht ablaufen. Siehe die Berechtigungs Übersicht für weitere Informationen über Web- und PIN-basierten Autorisierungsablauf.

Zugriff auf Token-Fehlerantworten

Inhaltstyp für alle Antworten: application/json .

Autorisierungscode abgelaufen

Einzelheiten
HTTP-Statuscode 400 schlechte Anfrage
Körper {
"error":"oauth2_error",
"error_description":"authorization code expired"
}
Erläuterung Der Autorisierungscode ist abgelaufen. Ein neuer Autorisierungscode wird benötigt, um ein Zugriffstoken anzufordern.

Autorisierungscode nicht gefunden

Einzelheiten
HTTP-Statuscode 400 schlechte Anfrage
Körper {
"error":"oauth2_error",
"error_description":"authorization code not found"
}
Erläuterung Der code Parameter ist ungültig. Überprüfen Sie, ob Sie den richtigen Autorisierungscode verwenden.

Client nicht aktiv

Einzelheiten
HTTP-Statuscode 403 Verboten
Körper {
"error":"client_not_active",
"error_description":"client is not active"
}
Erläuterung Überprüfen Sie, ob Sie die richtigen Parameter verwenden . Wenn die Parameter korrekt sind und der Fehler nur bei einigen Autorisierungsmethoden auftritt (z. B. ist die Autorisierung mit Postman erfolgreich, jedoch nicht mit Curl), liegt möglicherweise ein Fehler in Ihrer Syntax vor.

Dieser Fehler tritt auch auf, wenn Ihr Client deaktiviert ist.

Kundengeheimnis nicht gefunden

Einzelheiten
HTTP-Statuscode 400 schlechte Anfrage
Körper {
"error":"oauth2_error",
"error_description":"client secret not found"
}
Erläuterung Der Parameter client_secret ist ungültig. Überprüfen Sie, ob Sie den richtigen Wert für client_secret verwenden.

Fehlende erforderliche Parameter

Einzelheiten
HTTP-Statuscode 400 schlechte Anfrage
Körper {
"error":"oauth2_error",
"error_description":"missing required parameters: PARAM_NAME "
}
Erläuterung Ein erforderlicher Parameter, PARAM_NAME , fehlt in der Zugriffstokenanforderung.

redirect_uri nicht erlaubt

Einzelheiten
HTTP-Statuscode 400 schlechte Anfrage
Körper {
"error":"input_error",
"error_description":"redirect_uri not allowed"
}
Erläuterung Der Parameter redirect_uri wurde in der Zugriffstokenanforderung verwendet.