Oauth

  1. Home
  2. API Library
  3. Oauth
Der Schlüssel zum sicheren Zugang zu allen APIs

Oauth ist der Authentifizierungsdienst für die API-Nutzung und bietet eine sichere Verwaltung von Anfragen und Integrationen

All das Wissen, das Sie benötigen

Hier finden Sie einige Ratschläge, die Sie berücksichtigen sollten, um sich dieser API zu nähern. Wenn Sie möchten, bieten wir Code-Beispiele, OAS3-Dokumentation, die Möglichkeit, die API live über Swagger UI auszuprobieren oder die gesamte Sammlung in Postman zu importieren. Wir bieten auch eine Sandbox-Umgebung an, in der Sie kostenlos mit allen Arten von Anfragen experimentieren können.

Nützliche Tipps für den Einstieg Oauth

Überprüfen Sie Ihren API-Schlüssel im entsprechenden Abschnitt, bevor Sie beginnen.

Verwenden Sie Ihre E-Mail und Ihren API-Schlüssel, um Ihren "Basic Auth" Header zu erstellen und Anfragen an Tokens, Scopes, Credit und Counters durchzuführen.
Meinen API-Schlüssel überprüfen
API docs by Redocly

Oauth (1.0.0)

URL: https://openapi.it/en/support License: Apache 2.0 Terms of Service

Oauth ist unser wesentlicher Authentifizierungs-Webdienst, um unsere Dienste sicher zu nutzen. Über diesen Dienst können Sie wichtige Token erhalten, ändern und sehen, um auf alle anderen Methoden der Bienen zuzugreifen, die wir anbieten.

Weitere Informationen finden Sie unter https://developers.openapi.it/services/oauth
Entdecken Sie alle unsere Dienste unter https://developers.openapi.it/services

Zum ersten Mal hier? Generieren Sie ein neues Zugangstoken

token

Alle mit Ihrem Konto verbundenen Token empfangen, anzeigen und bearbeiten

Ein Token erhalten

Wenn Sie bei diesem Aufruf einen oder mehrere Bereiche übergeben, erhalten Sie ein Token, das Sie zur Authentifizierung mit denselben Bereichen benötigen, die Sie übergeben haben. Token mit Ablaufdatum können sehr nützlich sein, wenn Sie den Zugang auf eine kleine Anzahl von Bereichen beschränken wollen, die Ihre Anwendung/Dienst benötigt: Auf diese Weise können Sie unerwünschte Anfragen vermeiden

Authorizations:
basicAuth
Request Body schema: application/json
scopes
required
Array of strings

Liste der Bereiche, für die Sie eine Nutzungsberechtigung erhalten möchten; Sie können auch ein Sternchen als Platzhalter für alle Methoden oder alle Domänen oder alle Endpunkte übergeben. Wenn ich zum Beispiel alle Methoden und Endpunkte einer bestimmten Domäne '*:comparabili.openapi.it/*' haben möchte; wenn ich alle Bereiche '*:*/*' haben möchte

expire
integer
Deprecated
ttl
integer

Die Token-Lebensdauer (time-to-live) in Sekunden, bis zu einem Jahr; wenn nicht angegeben, wird beim Erstellen eines Tokens festgelegt, dass es in einem Jahr abläuft. Das Beispiel zeigt, wie man ein Token mit einer Lebensdauer von 30 Tagen anfordert.

Responses

Response Schema: application/json
scopes
Array of strings

Eine Liste der von Ihnen angeforderten Bereiche, erweitert

expire
integer

Ein UNIX-Zeitstempel in Sekunden, der das Verfallsdatum des Tokens angibt

token
string

Ihr neuer Token

success
boolean
message
string
error
integer

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "expire": 0,
  • "ttl": 2592000
}

Response samples

Content type
application/json
{
  • "scopes": [
    ],
  • "expire": 1634223407,
  • "token": "5f8711afe4754a532a7a8358",
  • "success": true,
  • "message": "",
  • "error": null
}

Liste aller nicht abgelaufenen Token

Methode, die alle Token zurückgibt, deren Geltungsbereiche für Ihr Konto noch aktiv sind

Authorizations:
basicAuth
query Parameters
scope
string
Example: scope=GET:imprese.openapi.it/base

Name des Bereichs, für den die Token gefiltert werden sollen

Responses

Response Schema: application/json
Array of objects
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://oauth.openapi.it/token?scope=SOME_STRING_VALUE");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Basic REPLACE_BASIC_AUTH");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

Findet ein bestimmtes Token

Methode, die das Token zurückgibt, das Sie im Pfad angegeben haben

Authorizations:
basicAuth
path Parameters
token
required
string
Example: 5f8041e42efdfc468b6e60ea

angefordertes Token

Responses

Response Schema: application/json
Array of objects
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://oauth.openapi.it/token/5f8041e42efdfc468b6e60ea");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Basic REPLACE_BASIC_AUTH");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

Aktualisierung des gesamten Token-Objekts

Methode, die es ermöglicht, das gesamte Token-Objekt zu ändern, indem neue Token oder die gleichen Referenzbereiche mit einer neuen Gültigkeitsdauer übergeben werden

Bitte beachten Sie, dass die TTL-Option für diese Methode nicht verfügbar ist.

Authorizations:
basicAuth
path Parameters
token
required
string
Example: 5f8041e42efdfc468b6e60ea

angefordertes Token

Request Body schema: application/json
scopes
required
Array of strings

Liste der Bereiche, für die Sie eine Nutzungsberechtigung erhalten möchten; Sie können auch ein Sternchen als Platzhalter für alle Methoden oder alle Domänen oder alle Endpunkte übergeben. Wenn ich zum Beispiel alle Methoden und Endpunkte einer bestimmten Domäne '*:comparabili.openapi.it/*' haben möchte; wenn ich alle Bereiche '*:*/*' haben möchte

expire
integer

Ein Verfallsdatum in Form eines UNIX-Zeitstempels in Sekunden. Wenn es nicht gesetzt wird, wird das Datum auf ein Jahr in der Zukunft gesetzt.

Responses

Response Schema: application/json
Array of objects
success
boolean
message
string
error
integer

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "expire": 1660640780
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

Teil des Token-Objekts aktualisieren

Methode, mit der Sie einzelne Felder des Token-Objekts ändern können, indem Sie ihm neue Felder oder dieselben Referenzbereiche oder eine neue Gültigkeitsdauer übergeben

Authorizations:
basicAuth
path Parameters
token
required
string
Example: 5f8041e42efdfc468b6e60ea

angefordertes Token

Request Body schema: application/json
scopes
required
Array of strings

Liste der Bereiche, für die Sie eine Nutzungsberechtigung erhalten möchten; Sie können auch ein Sternchen als Platzhalter für alle Methoden oder alle Domänen oder alle Endpunkte übergeben. Wenn ich zum Beispiel alle Methoden und Endpunkte einer bestimmten Domäne '*:comparabili.openapi.it/*' haben möchte; wenn ich alle Bereiche '*:*/*' haben möchte

expire
integer
Deprecated
ttl
integer

Die Token-Lebensdauer (time-to-live) in Sekunden, bis zu einem Jahr; wenn nicht angegeben, wird beim Erstellen eines Tokens festgelegt, dass es in einem Jahr abläuft. Das Beispiel zeigt, wie man ein Token mit einer Lebensdauer von 30 Tagen anfordert.

Responses

Response Schema: application/json
Array of objects
success
boolean
message
string
error
integer

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "expire": 0,
  • "ttl": 2592000
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

Löschen eines bestimmten Tokens

Methode, mit der Sie ein Token-Objekt aus Ihrem Konto löschen können

Authorizations:
basicAuth
path Parameters
token
required
string
Example: 5f8041e42efdfc468b6e60ea

angefordertes Token

Responses

Response Schema: application/json
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "https://oauth.openapi.it/token/5f8041e42efdfc468b6e60ea");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Basic REPLACE_BASIC_AUTH");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "message": "1 deleted token",
  • "success": true,
  • "error": null
}

scopes

Abrufen einer Liste der mit Ihrem Konto verbundenen Bereiche

Liste aller Geltungsbereiche

Methode, die die Liste aller Bereiche zurückgibt, für die Sie das Token angefordert haben und die daher mit Ihrem Konto verbunden sind

Authorizations:
basicAuth

Responses

Response Schema: application/json
data
Array of strings
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://oauth.openapi.it/scopes");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Basic REPLACE_BASIC_AUTH");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

credit

Ihr Openapi-Kredit

Ihr Openapi-Kredit

Methode, die Ihr verbleibendes Openapi-Guthaben zurückgibt

Authorizations:
basicAuth

Responses

Response Schema: application/json
object
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://oauth.openapi.it/credit");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Basic REPLACE_BASIC_AUTH");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "",
  • "error": null
}

counters

Holen Sie sich Ihre Nutzungsstatistiken

Ihre allgemeine Nutzung

Nutzungsstatistiken nach Bereich abrufen

Authorizations:
basicAuth

Responses

Response Schema: application/json
object
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://oauth.openapi.it/counters/total");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Basic REPLACE_BASIC_AUTH");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "",
  • "error": null
}

Nutzungsstatistiken für einen bestimmten Tag

Nutzungsstatistiken nach Bereich abrufen

Authorizations:
basicAuth
path Parameters
token
required
string
Example: 2022-01-01

Das gewünschte Datum, im Format JJJJ-MM-TT. Monate und Tage sollten mit führenden Nullen angegeben werden.

Responses

Response Schema: application/json
object
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://oauth.openapi.it/counters/day/%7Bday%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Basic REPLACE_BASIC_AUTH");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "",
  • "error": null
}

Nutzungsstatistiken für einen bestimmten Monat

Nutzungsstatistiken nach Bereich abrufen

Authorizations:
basicAuth
path Parameters
token
required
string
Example: 2022-01

Das gewünschte Datum, im Format JJJJ-MM. Die Monate sollten mit führenden Nullen angegeben werden.

Responses

Response Schema: application/json
object
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://oauth.openapi.it/counters/month/%7Bmonth%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Basic REPLACE_BASIC_AUTH");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "",
  • "error": null
}

Verwendungsstatistiken für ein bestimmtes Jahr

Nutzungsstatistiken nach Bereich abrufen

Authorizations:
basicAuth
path Parameters
token
required
string
Example: 2022

Das gewünschte Datum, im Format JJJJ.

Responses

Response Schema: application/json
object
success
boolean
message
string
error
integer

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://oauth.openapi.it/counters/year/%7Byear%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Basic REPLACE_BASIC_AUTH");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "",
  • "error": null
}
Web Service Revision: 2.0.0