Introduction

Cette page explique schématiquement le flux de données dans l'API.

API Flow

Les étapes pour obtenir des données de l'API Diamond Reports sont les suivantes :

1. Récupération des données à partir des points de terminaisons

Envoyez une demande GET aux points de terminaisons des données en joignant le token dans le header d'autorisation comme indiqué ci-dessous. Si vous n'avez pas de token, passez à l'étape 2.

Dans cet exemple, nous récupérons des données aux points de terminaisons/api/count. Le token est bearer_token

curl --request GET \
  --url 'https://example.diamondreports.ch/api/count' \
  --header 'authorization: Bearer bearer_token'

Si l'état de la réponse (response status) est 200, la récupération des données a réussi.

Si l'état de la réponse (response status) est 401, passez à l'étape 2.

2. Obtenir un nouveau token

Un nouveau token doit être demandé si et seulement si un token existant a expiré/invalide ou si un token n'existe pas.

Pour obtenir un jeton, une demande POST doit être envoyée au point de terminaison /token avec un payload comme ci-dessous:

payload = { 'grant_type': 'password', 'username': "YOUR_USERNAME", 'password': "YOUR_PASSWORD"}

Dans cet exemple, le nom d'utilisateur est TEST et le mot de passe est 123456.

// curl request
curl --request POST \
  --url 'https://example.diamondreports.ch/token' \
  --data 'grant_type=password&username=TEST&password=123456'

Exemple Python

# Python

import requests
import json

######################################################################
# USER INPUTS
######################################################################
url = "https://example.diamondreports.ch" # PLEASE EDIT THIS TO PUT THE BASE URL
payload = {
    'grant_type': 'password', 
    'username': "username",           # ENTER THE USERNAME
    'password': "password",           # ENTER THE PASSWORD
}
######################################################################

bearer = requests.post(url + "/token", data=payload)
token = bearer.json()['access_token']
headers = {"Authorization": "Bearer "+token}

response = requests.get(url  + "/api/count", headers=headers)