Oauth

  1. Home
  2. Libreria API
  3. Oauth
La chiave di accesso in sicurezza a tutte le API.

Oauth è il service di autenticazione per l'utilizzo delle API e garantisce la gestione sicura delle richieste e integrazioni.

Tutte le informazioni di cui hai bisogno

Qui trovi qualche consiglio da prendere in considerazione per approcciare a questa API. Se preferisci forniamo esempi di codice, documentazione in OAS3, la possibilità di provare l'API dal vivo con la Swagger UI oppure importare l'intera collezione in Postman. Offriamo inoltre un ambiente di Sandbox dove puoi sperimentare tutte le API gratuitamente.

Utili consigli per iniziare con Oauth

Controlla la tua APIkey nell'apposita sezione prima di cominciare.

Usa la tua email e la tua APIkey per creare un Header di tipo "Basic Auth" ed effettuare una richiesta a Tokens, Scopes, Credit e Counters
Controlla la mia APIkey

Crea il tuo primo Token.

Un token è una piccola chiave utilizzata per autenticare tutte le tue ulteriori richieste a qualsiasi API. Ha 2 attributi principali: "Scope" e "TTL". "Scopes" è un elenco di azioni disponibili dalla richiesta autenticata con il token generato. "TTL" definisce la data e l'ora di scadenza che avrà questo Token. Per motivi di sicurezza è meglio impostare token a scadenza rapida.
Approfondisci come creare un token

Controlla il tuo Credito via API.

Forniamo svariate configurazioni per impostare avvisi e notifiche sulla base del credito rimanente. Sono disponibili notifiche via SMS, EMAIL o la funzione Autoricarica per non "rimanere a secco".
Se preferisci puoi ottenere il valore del credito rimanente tramite API.
Approfondisci Vai a Preferenze

Raccogli le tue statistiche via API.

In ogni scheda API trovi la sezione "Utilizzo" dove puoi consultare tramite grafici e dati aggregati lo stato di utilizzo per ogni singolo Scope.
Nel caso in cui tu abbia bisogno di dati grezzi sull'utilizzo per creare la tua dashboard o impostare un sistema di notifica basato sull'utilizzo, forniamo un endpoint appositamente per questo scopo.
Approfondisci come ottenere i contatori via API
API docs by Redocly

Oauth (1.0.0)

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

Oauth è il nostro servizio web di autenticazione essenziale per utilizzare i nostri servizi in modo sicuro. Attraverso questo servizio è possibile ricevere, modificare e vedere i token essenziali per accedere a tutti gli altri metodi delle api che forniamo.

Vedi di più su https://developers.openapi.it/services/oauth
Esplora tutti i nostri servizi su https://developers.openapi.it/services

Prima volta qui? Generare un nuovo token di accesso

token

Ricevere, visualizzare e modificare tutti i token associati al proprio account

Ricevere un token

Con questa chiamata, passando uno o più ambiti, si riceve un token che servirà per autenticarsi con gli stessi ambiti passati. I token con data di scadenza possono essere molto utili se si vuole limitare l'accesso solo a un numero limitato di scope di cui la propria applicazione/servizio ha bisogno: in questo modo si possono evitare richieste indesiderate.

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

Elenco degli ambiti per i quali si vuole essere autorizzati all'uso; si può anche passare un asterisco come jolly per tutti i metodi o tutti i domini o tutti gli endpoint. Ad esempio, se voglio tutti i metodi e gli endpoint di un determinato dominio '*:comparabili.openapi.it/*'; se voglio tutti gli ambiti '*:*/*'

expire
integer
Deprecated
ttl
integer

La durata di vita del token (time-to-live) in secondi, fino a un anno; se non viene fornita, quando si crea un token, questo verrà impostato per scadere tra 1 anno. L'esempio mostra come richiedere un token con una durata di vita di 30 giorni.

Responses

Response Schema: application/json
scopes
Array of strings

Un elenco degli ambiti richiesti, espansi

expire
integer

Un timestamp UNIX, in secondi, che rappresenta la data di scadenza del token.

token
string

Il nuovo 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
}

Elenco di tutti i token non scaduti

Metodo che restituisce tutti i token con i loro scopi ancora attivi per l'account.

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

nome dell'ambito per il quale filtrare i 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?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
}

Trova un token specifico

Metodo che restituisce il token passato nel percorso

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

token richiesto

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
}

Aggiornare l'intero oggetto token

Metodo che consente di modificare l'intero oggetto token passandogliene di nuovi o gli stessi ambiti di riferimento con una nuova scadenza

Si noti che l'opzione TTL non è disponibile per questo metodo.

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

token richiesto

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

Elenco degli ambiti per i quali si vuole essere autorizzati all'uso; si può anche passare un asterisco come jolly per tutti i metodi o tutti i domini o tutti gli endpoint. Ad esempio, se voglio tutti i metodi e gli endpoint di un determinato dominio '*:comparabili.openapi.it/*'; se voglio tutti gli ambiti '*:*/*'

expire
integer

Una data di scadenza espressa come timestamp UNIX in secondi. Se non viene impostata, la data verrà impostata a un anno da oggi.

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
}

Aggiornare parte dell'oggetto token

Metodo che consente di modificare i singoli campi dell'oggetto token, passandogliene di nuovi o gli stessi ambiti di riferimento o una nuova scadenza.

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

token richiesto

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

Elenco degli ambiti per i quali si vuole essere autorizzati all'uso; si può anche passare un asterisco come jolly per tutti i metodi o tutti i domini o tutti gli endpoint. Ad esempio, se voglio tutti i metodi e gli endpoint di un determinato dominio '*:comparabili.openapi.it/*'; se voglio tutti gli ambiti '*:*/*'

expire
integer
Deprecated
ttl
integer

La durata di vita del token (time-to-live) in secondi, fino a un anno; se non viene fornita, quando si crea un token, questo verrà impostato per scadere tra 1 anno. L'esempio mostra come richiedere un token con una durata di vita di 30 giorni.

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
}

Eliminare un token specifico

Metodo che consente di eliminare un oggetto token dal proprio account

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

token richiesto

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

Ottenere un elenco di ambiti associati al proprio account

Elenco di tutti gli ambiti

Metodo che restituisce l'elenco di tutti gli ambiti per i quali è stato richiesto il token e quindi associati al proprio account.

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

Your Openapi credit

Your Openapi credit

Metodo che restituisce il credito Openapi rimanente

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

Ottenere le statistiche di utilizzo

L'utilizzo complessivo

Ottenere le statistiche di utilizzo per ambito

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
}

Statistiche di utilizzo per un giorno specifico

Ottenere le statistiche di utilizzo per ambito

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

La data richiesta, nel formato AAAA-MM-GG. I mesi e i giorni devono essere con gli zeri iniziali.

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
}

Statistiche di utilizzo per un mese specifico

Ottenere le statistiche di utilizzo per ambito

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

La data richiesta, nel formato AAAA-MM. I mesi devono essere con gli zeri iniziali.

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
}

Statistiche di utilizzo per un anno specifico

Ottenere le statistiche di utilizzo per ambito

Authorizations:
basicAuth
path Parameters
token
required
string
Example: 2022

La data richiesta, nel formato YYYY.

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