(Digitale) Ladekarten abrufen¶
Übersicht¶
Anhand einer Ladekarte kann das Backend erkennen, ob und zu welchen Konditionen der Nutzer an einer Ladesäule laden darf. Daher stellt sie das zentrale Authentifizierungsmedium des Nutzers gegenüber der Ladesäule (und dem Backend) dar.
Im Alltagsgebrauch sind Ladekarten häufig Plastikkarten oder Schlüsselanhänger. Neben den phsyischen "Karten" können auch auch rein virtuelle Ladekarten genutzt werden. In der CONNECT API stellen sie den Zugang oder auch den Vertrag dar. Dabei kann ein Kontakt mehere solche Karten besitzen. Sowohl auf die physische, als auch auf die digitale Ladekarte kann über die API zugegriffen werden, um so Ladevorgänge über die API zu starten oder zu stoppen.
Struktur¶
Alle Ladekarten müssen mit einem Kontakt/Kunde verknüpft sein, der der Inhaber dieser Ladekarten ist. Grundsätzlich ist dieser Kontakt/Kunde Empfänger der Rechnung über alle Ladevorgänge, die mit den (virtuellen) Ladekarten an den Ladestationen der Entität / Unternehmen durchgeführt wurden.
Über einen Tarif werden Zugriff und Konditionen innerhalb des Ladenetzes für den Nutzer bestimmt.
Alle mit einer Ladekarte getätigten Ladevorgänge können über die jeweilige Ladekarte abgerufen werden und werden dem jeweiligen Rechnungsempfänger in Rechnung gestellt.
Ladekarten abrufen¶
Je nach Szenario gibt es verschiedene Möglichkeiten, (digitale) Ladekarten[^1] über unsere API abzurufen:
- Wählen Sie eine bestimmte Ladekarte aus, mit getCard.
- Rufen Sie alle verfügbaren Karten eines Kontaktes ab, mit getCards.
Hier ist eine Beispielanfrage mit der, Ladekarten eines Kontaktes abgerufen werden können:
query getCards($contactId: String!) {
getCards(contactId: '7fe42322-7e42-4b42-864e-e42ce703c429') {
active
billingContact
cardType
contact
name
rate
tagId
validFrom
}
}
Ladekarten müssen aktiviert und einem Kontakt zugeordnet sein, damit sie genutzt werden können!
Eine Ladekarte funktioniert nur, wenn sie aktiviert und einem Nutzer zugeordnet ist!
Eine Ladekarte kann nur einem Nutzer zugeordnet werden.
Zugriffskontrolle und Konditionen
Anhand des Tarifes der Ladekarte wird festgelegt an welchen Ladestationen der Nutzer zu welchen Konditionen laden darf!
Ladekarten ändern¶
Es gibt die Möglichkeit den Namen und den Status einer Ladekarte anzpassen.
Den Namen einer Karte kann man nutzen um sie zu personalisieren. Dieser Name taucht später auf der Rechnung, die an den Kunden geht auf und hilft so bei der Zuordnung.
Den (Aktivitäts-)Status der Karte kann man ebenfalls einstellen. Ist der Status true
, kann die Karte regulär genutzt werden um Ladevorgänge zu starten. Ist der Status false
ist sie deaktiviert. Neue Ladevorgänge können damit dann nicht mehr gestartet werden. Bereits gestartete Vorgänge werden regulär beendet und abgerechnet.
In diesem Beispiel würde der Status einer Karte mit updateCard auf false
gesetzt werden, um sie zu deaktivieren.
mutation updateCard($tagId: String!, $name: String, $active: Boolean) {
updateCard(tagId: 'ABC123', active: false) {
active
billingContact
cardType
contact
name
rate
tagId
validFrom
}
}
Die Beschreibung der einzelnen Felder sind in Card definiert.