Einleitung

Diese Seite erklärt kurz den Datenfluss in der API.

API Flow

Wie man Daten aus der Diamond Reports API abrufen kann:

1. Daten von den Endpunkten abrufen

Sende eine GET-Anforderung an die Datenendpunkte, indem der Token wie unten beschrieben in den Authorization-Header eingefügt wird. Wenn kein Token besteht, lese Schritt 2.

In diesem Beispiel holen wir Daten vom Endpunkt /api/count ab. Der Token lautet bearer_token

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

Ist der Antwortstatus 200, war der Datenabruf erfolgreich.

Ist der Antwortstatus 401, lese bitte Schritt 2.

2. Neuer Token bekommen

Ein neuer Token sollte nur dann angefordert werden, wenn ein vorhandener Token abgelaufen/ungültig ist oder kein Token existiert.

Um ein Token zu erhalten, muss eine POST-Anfrage an den Endpunkt /token mit "payload" wie folgt geschickt werden:

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

In diesem Beispiel lautet der Benutzername "TEST" und das Passwort "123456".

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

Python Beispiel

# 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)