Oauth

  1. Home
  2. Bibliothèque d'API
  3. Oauth
La clé pour sécuriser l'accès à toutes les API.

OAuth est le service d'authentification pour l'utilisation de l'API et fournit une gestion sécurisée des demandes et des intégrations.

Toutes les connaissances dont vous avez besoin

Vous trouverez ici quelques conseils à prendre en compte pour aborder cette API. Si vous préférez, nous fournissons des exemples de code, la documentation OAS3, la possibilité d'essayer l'API en direct via Swagger UI ou d'importer l'intégralité de la collection dans Postman. Nous proposons également un environnement Sandbox où vous pouvez expérimenter toutes sortes de requêtes de manière totalement gratuite.

Conseils utiles pour commencer Oauth

Vérifiez votre clé API dans la section appropriée avant de commencer.

Utilisez votre adresse e-mail et votre clé API pour créer votre en-tête "Basic Auth" et effectuer des requêtes sur les jetons, les étendues, le crédit et les compteurs.
Vérifiez ma clé API
API docs by Redocly

Oauth (1.0.0)

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

Oauth est notre service web d'authentification essentiel pour utiliser nos services en toute sécurité. Grâce à ce service, vous pouvez recevoir, modifier et voir les jetons essentiels pour accéder à toutes les méthodes de repos des abeilles que nous fournissons.

En savoir plus sur https://developers.openapi.it/services/oauth
Explorer tous nos services sur https://developers.openapi.it/services

C'est la première fois que vous venez ici ? Générer un nouveau jeton d'accès

token

Recevoir, consulter et modifier tous les jetons associés à votre compte

Recevoir un jeton

En passant un ou plusieurs scopes, vous recevez un jeton dont vous aurez besoin pour vous authentifier auprès des mêmes scopes que ceux que vous avez passés. Les jetons avec des dates d'expiration peuvent être très utiles si vous souhaitez restreindre l'accès à un petit nombre de scopes dont votre application/service a besoin : de cette manière, vous pouvez éviter les requêtes non désirées

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

Liste des champs d'application pour lesquels vous voulez être autorisé à utiliser ; vous pouvez également passer un astérisque comme joker pour toutes les méthodes, tous les domaines ou tous les points de terminaison. Par exemple, si je veux toutes les méthodes et tous les points de terminaison d'un domaine donné "*:comparabili.openapi.it/*" ; si je veux tous les domaines "*:*/*".

expire
integer
Deprecated
ttl
integer

La durée de vie du jeton (time-to-live) en secondes, jusqu'à un an ; si elle n'est pas fournie, lors de la création d'un jeton, celui-ci expirera dans un an. L'exemple montre comment demander un jeton ayant une durée de vie de 30 jours.

Responses

Response Schema: application/json
scopes
Array of strings

Une liste des champs d'application que vous avez demandés, élargie

expire
integer

Un timestamp UNIX, en secondes, représentant la date d'expiration du jeton.

token
string

Votre nouveau jeton

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 de tous les jetons non expirés

Méthode qui renvoie tous les tokens dont les champs d'application sont encore actifs pour votre compte.

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

nom de l'étendue pour laquelle filtrer les jetons

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
}

Recherche d'un jeton spécifique

Méthode qui renvoie le jeton que vous avez passé dans le chemin d'accès

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

jeton demandé

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
}

Mise à jour de l'ensemble de l'objet token

Méthode qui vous permet de modifier l'objet token entier en lui passant de nouveaux tokens ou les mêmes reference scopes avec une nouvelle expiration

Veuillez noter que l'option TTL n'est pas disponible pour cette méthode.

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

jeton demandé

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

Liste des champs d'application pour lesquels vous voulez être autorisé à utiliser ; vous pouvez également passer un astérisque comme joker pour toutes les méthodes, tous les domaines ou tous les points de terminaison. Par exemple, si je veux toutes les méthodes et tous les points de terminaison d'un domaine donné "*:comparabili.openapi.it/*" ; si je veux tous les domaines "*:*/*".

expire
integer

La date d'expiration est exprimée sous la forme d'un horodatage UNIX en secondes. Si elle n'est pas définie, la date sera fixée à un an à partir de maintenant.

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
}

Mise à jour d'une partie de l'objet token

Méthode permettant de modifier les champs individuels de l'objet token en lui transmettant de nouveaux champs ou les mêmes champs de référence ou une nouvelle expiration.

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

jeton demandé

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

Liste des champs d'application pour lesquels vous voulez être autorisé à utiliser ; vous pouvez également passer un astérisque comme joker pour toutes les méthodes, tous les domaines ou tous les points de terminaison. Par exemple, si je veux toutes les méthodes et tous les points de terminaison d'un domaine donné "*:comparabili.openapi.it/*" ; si je veux tous les domaines "*:*/*".

expire
integer
Deprecated
ttl
integer

La durée de vie du jeton (time-to-live) en secondes, jusqu'à un an ; si elle n'est pas fournie, lors de la création d'un jeton, celui-ci expirera dans un an. L'exemple montre comment demander un jeton ayant une durée de vie de 30 jours.

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
}

Supprimer un jeton spécifique

Méthode permettant de supprimer un objet token de votre compte

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

jeton demandé

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

Obtenir une liste des champs d'application associés à votre compte

Liste de toutes les portées

Méthode qui renvoie la liste de tous les champs d'application pour lesquels vous avez demandé le jeton et qui sont donc associés à votre compte.

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

Votre crédit Openapi

Votre crédit Openapi

Méthode qui renvoie le crédit Openapi restant

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

Obtenez vos statistiques d'utilisation

Votre utilisation globale

Obtenez vos statistiques d'utilisation par champ d'application

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
}

Statistiques d'utilisation pour un jour donné

Obtenez vos statistiques d'utilisation par champ d'application

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

La date demandée, au format AAAA-MM-JJ. Les mois et les jours doivent être précédés de zéros.

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
}

Statistiques d'utilisation pour un mois spécifique

Obtenez vos statistiques d'utilisation par champ d'application

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

La date demandée, au format AAAA-MM. Les mois doivent être précédés de zéros.

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
}

Statistiques d'utilisation pour une année spécifique

Obtenez vos statistiques d'utilisation par champ d'application

Authorizations:
basicAuth
path Parameters
token
required
string
Example: 2022

La date demandée, au format AAAA.

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