MACO APP | DOC
FUM 10 / 25
  • FUM 10 / 25
  • FUM 04 / 25
SchnittstellenProzessdokumentationenBO4E Geschäftsobjekte
SchnittstellenProzessdokumentationenBO4E Geschäftsobjekte
FUM 10 / 25
  • FUM 10 / 25
  • FUM 04 / 25
  1. Trigger (MACO APP)
  • Übersicht
  • Änderungsprotokoll Schnittstellen
  • Fehlercodes
  • Geschäftsobjekte
  • Trigger (MACO APP)
    • Einzelansicht LF
      • ECS Steuerprozess Lieferbeginn
        POST
      • Identifikation einer Marktlokation
        POST
      • Kündigungsprozess zwischen Lieferanten
        POST
      • Lieferbeginn
        POST
      • Lieferende von Lieferant an Netzbetreiber
        POST
      • Stammdatenänderung vom Lieferanten (verantwortlich)
        POST
    • Einzelansicht NB
      • Anfrage zur Beendigung der Zuordnung des LFA zur Marktlokation bzw. Tranche
      • Aufhebung der Zuordnung des LFZ zur Marklokation bzw. Tranche versenden
      • Beendigung der Zuordnung des LFA zur Marklokation bzw. Tranche
      • Abrechnungsdaten Netznutzungsabrechnung versenden
      • Abrechnungsdaten Bilanzkreisabrechnung versenden
      • Stammdatenänderung vom Netzbetreiber (verantwortlich)
      • Einrichtung der Konfigurationen aufgrund einer Zuordnung eines LF zu einer MaLo oder Tranche
      • Übermittlung der Berechnungsformel
      • Wiederherstellung Anschlussnutzung nach LB
      • Lieferende von Netzbetreiber an Lieferant
      • Ersatz-/Grundversorgung
    • Einzelansicht MSB
      • Stammdatenänderung vom Messstellenbetreiber (verantwortlich)
    • Trigger Events
      POST
    • Authentifizierung
      POST
  • BO4E Lesen (Backend)
    • Avis lesen
    • Berechnungsformel lesen
    • Bilanzierung lesen
    • Energieliefervertrag lesen
    • Energiemengen aus Abrechnungskontext lesen
    • Lastgangs einer Lokation lesen
    • Zählerstand einer Lokation lesen
    • Kommunikationsdaten des Serviceanbieters lesen
    • Lokationsbündel lesen
    • Marktlokation lesen
    • Messlokation lesen
    • Messstellenbetriebsvertrag lesen
    • Netzlokation lesen
    • Netznutzungsvertrag lesen
    • Steuerbare Ressource lesen
    • Technische Ressource lesen
    • Tranche lesen
    • Zähler lesen
  • Prozessdaten lesen (Backend)
    • Zuordnungsemächtigung lesen
  • Prozessdaten LF (Backend)
    • Prozessdaten aktualiseren
    • Prozessdaten erstellen
  • Prozessdaten NB (Backend)
    • Prozessdaten aktualiseren
    • Prozessdaten erstellen
  • Prozessdaten MSB (Backend)
    • Prozessdaten aktualiseren
    • Prozessdaten erstellen
  • MaloIdent LF (Backend)
    • Prozessdaten aktualisieren
    • Identifikation einer Marktlokation
  • MaloIdent NB (Backend)
    • Identifizierung der MaLo
    • Stammdaten der identifiz. MaLo
  • Obsolet
    • Verwendungszeitraum einer Marktlokation ermitteln
    • Absenderdaten lesen
    • Empfängerdaten lesen
  • MaLo-Ident
    • Übersicht
    • MaloIdent Anfrage auslösen
      POST
    • Identifizierung der MaLo
      POST
    • Stammdaten der identifiz. MaLo
      GET
    • Prozessdaten aktualisieren
      POST
  • MCS Eingang (MACO APP)
    • Empfang einer Marktnachricht
  1. Trigger (MACO APP)

Authentifizierung

Developing
POST
{{auth-token-url}}
OperationId:login

Authentifizierung via MACO APP OAuth (Service-Login für Trigger-Schnittstellen)#

Für den Zugriff auf ausgewählte Trigger-Schnittstellen der MACO APP erfolgt die Authentifizierung über einen OAuth-basierten Login. Dieses Verfahren ist ausschließlich für Services vorgesehen – also für Systeme, die automatisiert mit der MACO APP kommunizieren, nicht für interaktive Benutzeranmeldung.
Nach erfolgreicher Anmeldung steht dir ein Access Token zur Verfügung, mit dem du in freigeschalteten Umgebungen Requests direkt über die API-Dokumentation testen kannst.

Ziel#

Du möchtest:
deinen Service gegenüber der MACO APP authentifizieren,
ein Access Token automatisiert abrufen,
dieses Token in API-Requests verwenden,
und freigegebene Schnittstellen über die Doku testen.
Genau dafür ist dieser Loginflow gedacht.

Voraussetzungen#

Folgende Umgebungsvariablen müssen in Apidog (bzw. im Testtool deiner Wahl) definiert werden:
VariableBeschreibung
usernameTechnischer Benutzername (Service-Account)
passwordPasswort für den Service-Account
authTokenUrlToken-Endpunkt der MACO APP OAuth-Anmeldung
clientIdDie zugewiesene Client-ID
clientSecret(Optional) Das Secret, falls für deinen Client erforderlich
Wichtig:
Diese Werte sind abhängig von der Umgebung (z. B. Test, Staging, Produktion) und werden dir beim Onboarding durch das MACO APP Team individuell bereitgestellt. Verwende ausschließlich die dir zugewiesenen Zugangsdaten.

Login und Token-Nutzung#

1. Login-Request erstellen#

Erzeuge einen POST-Request auf {{authTokenUrl}}
Setze den Content-Type auf: application/x-www-form-urlencoded

2. Body-Parameter setzen#

Verwende folgende Felder im Body des Requests:
grant_type=password
client_id={{clientId}}
client_secret={{clientSecret}}  // falls notwendig
username={{username}}
password={{password}}

3. Access Token speichern#

Das Antwortfeld access_token enthält deinen Token.
Speichere diesen als Umgebungsvariable accessToken, damit du ihn in weiteren Requests nutzen kannst.

4. Token verwenden#

Füge in jedem weiteren Request diesen Header ein:
Authorization: Bearer {{accessToken}}

Ablaufdiagramm#


Anwendung über die API-Doku#

Sobald dein Token gespeichert ist, kannst du damit in freigeschalteten Umgebungen direkt über die MACO APP API-Dokumentation Anfragen ausführen – z. B. zum Auslösen von Prozessen oder Testen von Integrationen.
Die verfügbaren Endpunkte variieren je nach Umgebung und Berechtigungen.

Sicherheit beachten#

Der Token ist zeitlich begrenzt gültig (i. d. R. 5–15 Minuten).
Bei Bedarf kann zusätzlich ein Refresh Token verwendet werden.
Nutze ausschließlich HTTPS.
Tokens dürfen nicht in Logs oder öffentlich zugänglichen Systemen gespeichert werden.

Zusammenfassung#

Mit diesem Setup kannst du:
deinen Service automatisiert gegen die MACO APP authentifizieren,
Trigger-Schnittstellen nutzen,
Token-Handling zentral verwalten,
und Anfragen direkt über die API-Dokumentation testen.

Falls du noch Fragen zur Nutzung in speziellen Umgebungen oder zu erweiterten OAuth-Szenarien hast (z. B. Mandantenkontexte, Rollenmapping, Claim-Handling):
Wende dich gern an das Architektur-Team.

Request

Header Params

Body Params application/x-www-form-urlencoded

Responses

🟢200Success
application/json
Body

Example
{}
Previous
Trigger Events
Next
BO4E Lesen (Backend)