Allgemeines¶

Verschlüsselung¶

Die Kommunikation mir dem connect center erfolgt verschlüsselt über das https Protokoll (Server-Side-Certificat).

Authentifizierung¶

Die Authentifizierung im connect center erfolgt per Anmeldung mit UserID und Passwort beim API-Aufruf getToken. Sie liefert einen Token, der für alle weitere Kommunikation mit dem connect center erforderlich ist.

Sollte die Authentifizierung mit dem connect center fehlschlagen, wird grundsätzlich der Errorcode 401 zurückgegeben. Zusätzlich werden im Requestbody noch weitere Informationen zur fehlgeschlagenen Authentifizierung ausgegeben.

Infotext	Erläuterung
missing param token	In der Anfrage wurde kein Token mitgeschickt.
token is unknown	Die Token-ID ist dem connect center nicht bekannt.
token timeout	Die Session des Tokens ist abgelaufen. Es muss ein Neues Token angefordert werden.

Token¶

getToken¶

Erzeugt einen Token für die Kommunikation mit dem connect center. Der Token ist eine 64 Zeichen lange hexadezimale Zeichenkette (SH256 Hashkey).

Aufruf	https://connectcenter.agof.de/getToken/
Methoden	GET
Rückgabe	64 Zeichen langer String

¶

Parameter
id	Name des Users im connect center
password	Passwort des Users

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
400	missing params	Parameter id und/oder password wurden nicht übergeben
409	unknown user	User mit entsprechenden id nicht bekannt.
403	password wrong	User konnte nicht authentifiziert werden.

Der Token ist bis zu einer Stunde nach der letzten Kommunikation mit dem Center über dieses Token gültig. Bei jedem Aufruf einer Funktion des Connect Centers muss dieser Token mitgeführt werden (Parameter “token”).

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/getToken/ -d id="Vermarkter 1" -d password="Vermarkter 1" --insecure

Rückgabe¶

35222a967536787a57c7b5d3f031a0c22ebf88ee72db4c50cbb55fbbde43abb3

Nutzerkennung¶

getConnectUsers¶

Für die Kommunikation mit einem Connect User, wird dessen ID im connect center benötigt. Eine Liste der vorhandenen User kann man über den Befehl getConnectUsers bekommen. Die id des Users steht im id Tag. Sie verändert sich für einen User nicht.

Aufruf	https://connectcenter.agof.de/getConnectUsers/
Methoden	GET
Rückgabe	XML-Liste der User (encoding: utf-8)

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/getConnectUsers/ --insecure 
 -d token=74342db8e8cfe22a849c97e152f04d402bef1ecd4708bf03345756d7c354a0b8

Rückgabe¶

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Users created='2013-11-25 15:40:36'>
  <User>
    <id>2</id>
    <name>Vermarkter 1</name>
    <type>publisher</type>
    <publicKeyId>0010_8583989f039cde46632efde76fdd1144</publicKeyId>
    <publicKey>
      <RSAKeyValue>
        <Modulus>
        wkf1APMaqwM1Oj92Lihw2rFDF9xUxB6g39irWt+hurDwQxZ670aM5C39AvYPMBqSzJKRhX5e26U3+E0QJBORnY66y6nYo5qmpLdtwOOSdREwJlMb3vyD0bjQ0WDHEr0EiQf39N1z0SXuq4aFE3biVwgrGvVBAEYqqeYyHnUb+ok=</Modulus>
        <Exponent>AQAB</Exponent>
      </RSAKeyValue>
    </publicKey>
  </User>
  <User>
    <id>3</id>
...

Aktivität¶

getProtocols¶

Ruft ab, welche Aktionen im Konto des Users in einem gegebenen Zeitraum ausgeführt wurden

Aufruf	https://connectcenter.agof.de/getProtocols/
Methoden	GET
Rückgabe	XML-Liste der Aktionen (encoding: utf-8)

¶

Parameter
fromDate	Datum, ab dem das Protokoll beginnen soll, optional, Format: “DD.MM.JJJJ” bzw. “DD.MM.JJJ HH:MM” (z.B. 01.01.2013 13:00). Uhrzeit ist im 24h Format und optional.
toDate	Datum, bei dem das Protokoll enden soll, optional, Format wie fromDate

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/getProtocols/ --insecure 
 -d token=74342db8e8cfe22a849c97e152f04d402bef1ecd4708bf03345756d7c354a0b8

Rückgabe¶

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<History>
  <Entry>
    <User>
      <id>4</id>
      <name>Vermarkter 2</name>
    </User>
    <Action>Create Box for User</Action>
    <Date>2013-09-05 18:50:26.0</Date>
  </Entry>
  <Entry>
    <User>
      <id>4</id>
      <name>Vermarkter 2</name>
    </User>
    <Action>Read XML from userbox (Inventory)</Action>
    <Date>2013-11-25 15:40:37.0</Date>
  </Entry>
  <Entry>
    <User>
      <id>4</id>
      <name>Vermarkter 2</name>
    </User>
    <Action>Read XML from userbox (PriceLists)</Action>
    <Date>2013-11-25 15:40:37.0</Date>
  </Entry>
  <Entry>
    <User>
      <id>4</id>
      <name>Vermarkter 2</name>
    </User>
    <Action>Read XML from userbox (Advertisments)</Action>
    <Date>2013-11-25 15:40:38.0</Date>
  </Entry>
</History>
...