Einleitung

Authentifizierung

Die API stellt z.T. Informationen zur Verfügung, die nur für bestimmte Kunden / Nutzer gedacht sind. Aus diesem Grund können keine Informationen ohne einen vorher angelegten Zugang abgerufen werden.

Zum Schutz der Daten, werden durch die Authentifizierung auch die Zugriffsrechte gesteuert und alle Zugriffe protokoliert.

Per API Key (PSK)

Um sich gegenüber der API zu authentifizieren erhalten Sie von uns einen API Key. Dieser API muss dann bei jeder Abfrage als x-api-key im Header mitgegeben werden.

Bash

curl --location --request POST '<api-url>/graphql' \
--header 'x-api-token: XXXXXXXXXXXXXXXXXXXXXXXXXX'
--header 'Content-Type: application/json' \
--data-raw '{"query":"query getChargepoints($count: Int, $page: Int) {\r\n  getChargepoints(count: 100, page: 0) {\r\n    chargepoints {\r\n      uuid\r\n      publicName\r\n      connectorsTotal\r\n      connectorsFree\r\n      connectorsOccupied\r\n      connectorsUnavailable\r\n      connectors {\r\n        uuid\r\n        name\r\n        status {\r\n          status\r\n          updatedAt\r\n        }\r\n        evse\r\n        type\r\n      }\r\n    }\r\n    nextPage\r\n    count\r\n    total\r\n  }\r\n}","variables":{}}'

Python

import requests
import json

url = "<api-endpoint>"

payload="{\"query\":\"query getChargepoints($count: Int, $page: Int) {\\r\\n  getChargepoints(count: 100, page: 0) {\\r\\n    chargepoints {\\r\\n      uuid\\r\\n      publicName\\r\\n      connectorsTotal\\r\\n      connectorsFree\\r\\n      connectorsOccupied\\r\\n      connectorsUnavailable\\r\\n      connectors {\\r\\n        uuid\\r\\n        name\\r\\n        status {\\r\\n          status\\r\\n          updatedAt\\r\\n        }\\r\\n        evse\\r\\n        type\\r\\n      }\\r\\n    }\\r\\n    nextPage\\r\\n    count\\r\\n    total\\r\\n  }\\r\\n}\",\"variables\":{}}"
headers = {
  'x-api-key': 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Wichtig!

API Keys sind dafür gedacht andere Dienste zu authentifizieren. Sie sollten nicht weitergegeben werden oder für dritte sichtbar sein.

Einschränkungen

Nutzung der API

Die API wurde entwickelt um unseren Kunden die Dienste rund um ihre Ladeinfrastruktur oder Fahrstromverträge anbieten zu können. Sie ist für eine M2M-Verbindung, also Server-zu-Server Verbindung, und nicht für eine direkte Anbindung von Anwendendungen vorgesehen.

Verfügbarkeit

Diese API befindet sich in der Entwicklung und wird daher regelmäßig gewartet und erweitert. Sofern es zu Einschränkungen im Betrieb kommt werden wir darüber informieren. Sollte es jedoch zu unerwarteten Ausfällen kommen, versuchen wir schnellstmöglich alles wiederherzustellen.