Docs API | CODE24

1.API-Schnittstelle

1.1.Einleitung

CODE24 stellt Ihnen eine professionelle Einbindung via API-Schnittstelle zur Verfügung, welche folgende Webservices ermöglicht:

Code-Prüfung
Registrierung eines Produktes
Änderung der Kundendaten
Verlängerung einer Laufzeit

Hierfür bietet CODE24 seinen Kunden eine REST-Schnittstelle an, die via verschiedene Requests aufgerufen werden kann. Wir bieten dafür folgende Requests an:

HTTP
cURL
PHP

Dadurch ermöglicht CODE24 seinen Kunden, das Benutzerinterface
zur Prüfung, Registrierung, Datenänderung, Verlängerung vollständig selbst zu gestalten und optimal in das Frontend der Webseite zu integrieren.

Die WebService-Schnittstelle antwortet mit einem JSON Object, das auf Seiten des Kunden automatisiert ausgewertet werden kann – etwa zur Rückmeldung von Validierungsfehlern.

1.2.Allgemeine Regeln

Die WebService-API wird über folgende URL aufgerufen. Bitte beachten Sie dabei das HTTPS-Protokoll.
Alle Parameter werden via HTTP-POST übergeben.

https://code24.de

1.3.Webservices

1.3.1.1. Code Prüfung

Sie können unsere Schlüsselnummern direkt online prüfen und erhalten sofort eine Nachricht, ob der Code gültig ist oder nicht bzw. ob dieser bereits registriert ist.

POST /?keyfinder_check&json_response

1.3.1.1.Post fields (form-data)

```
code
```
Benötigt. (String) – prüft den Code (Beispiel: A160045)

1.3.1.2.Query String Parameter

```
keyfinder_check
```
– Benötigt. (String) – startet die Aktion um den Code zu prüfen
```
json_response
```
– Benötigt. (String) – sendet JSON anstelle von HTML

1.3.1.3.Beispiel Aufruf HTTP

POST /?keyfinder_check&json_response HTTP/1.1
Host: code24.de
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
code=A160045

1.3.1.4.Beispiel Aufruf cURL

curl -X POST -F "code=A160045" "https://code24.de/?keyfinder_check&json_response"

1.3.1.5.Beispiel Aufruf PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://code24.de/?keyfinder_check=&json_response=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_TIMEOUT => 5,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "code=A160045",
  CURLOPT_HTTPHEADER => array(
    "content-type: application/x-www-form-urlencoded",
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

1.3.1.6.Beispiel Ergebnis JSON Object

{
  "error": false,
  "success": true,
  "registered": false,
  "period": 0
}

1.3.1.7. Antwort-Schema bei Erfolg

```
success
```
– (Boolean) – Gibt an, ob die Überprüfung erfolgreich war (Code existiert oder nicht)
```
registered
```
– (Boolean) – Gibt an, ob der Code bereits registriert wurde oder nicht
```
period
```
– (Int) – Gibt den Zeitraum des Codes an

1.3.1.8.Antwort-Schema bei Misserfolg

```
error
```
– (Boolean) – Rückgabe true, wenn Fehler auftreten. Fehlermeldung wird mit folgendem string und einer benutzerfreundlichen Nachricht zur Verfügung gestellt:
```
message
```

1.3.2.2. Code Registrierung

Sie können den geprüften Code direkt online registrieren. Dafür müssen entsprechende Parameter übergeben werden.

POST /?keyfinder_register&json_response

1.3.2.1.Post fields

```
keyfinder_register
```
– Benötigt. (String) – Wert ist optional. Startet die Registrierungs Session.
```
code
```
– Benötigt. (String) – Der zu registrierende Code (Beispiel:
```
A160045
```
)
```
street
```
– Benötigt. (String) – Kundenanschrift Strasse und Hausnummer
```
zip
```
– Benötigt. (String) – Kundenanschrift PLZ
```
city
```
– Benötigt. (String) – Kundenanschrift Stadt
```
country
```
– Benötigt. (String) – Kundenanschrift Land
```
email
```
– Benötigt. (String) – Kundenanschrift E-Mail
```
salutation
```
– Benötigt. (String) – Kundenanschrift Anrede
```
firstname
```
– Benötigt. (String) – Kundenanschrift Vorname
```
lastname
```
– Benötigt. (String) – Kundenanschrift Nachname
```
phone
```
– Benötigt. (String) – Kundenanschrift Telefon
```
period
```
– Benötigt. (Int) – Kundenanschrift Laufzeit (Wird vom Server automatisch vergeben, Standard 1 Jahr)

1.3.2.2.Query String Parameter

```
keyfinder_register
```
– Benötigt. (String) – startet die Aktion um den Code zu registrieren
```
json_response
```
– Benötigt. (String) – sendet JSON anstelle von HTML

1.3.2.3.Beispiel Aufruf HTTP

POST /?keyfinder_register&amp;json_response HTTP/1.1
Host: code24.de
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded

keyfinder_register=1&code=A160045&city=Mannheim&country=DE&email=gw%40millenium.de&firstname=Max&lastname=Mustermann&period=1&phone=062112855440&salutation=Herr&street=Hafenstr.+86&zip=68159

1.3.2.4.Beispiel Aufruf cURL

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'keyfinder_register=1&code=A160045&city=Mannheim&country=DE&email=gw@millenium.de&firstname=Max&lastname=Mustermann&period=1&phone=062112855440&salutation=Herr&street=Hafenstr. 86&zip=68159' "https://code24.de/?keyfinder_register=&json_response="

1.3.2.5.Beispiel Aufruf PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://code24.de/?keyfinder_register=&json_response=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_TIMEOUT => 10,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "keyfinder_register=1&code=A160045&city=Mannheim&country=DE&email=gw%40millenium.de&firstname=Max&lastname=Mustermann&period=1&phone=062112855440&salutation=Herr&street=Hafenstr.%2086&zip=68159",
  CURLOPT_HTTPHEADER => array(
    "content-type: application/x-www-form-urlencoded"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

1.3.2.6.Beispiel Ergebnis JSON Object

On success: HTTP 200 OK

{
  "error": false,
  "message": "Wurde erfolgreich registriert."
}

On error: HTTP 500 Internal Server Error

{
  "error": true,
  "message": "Fehler! Dieser Code wurde nicht gefunden oder ist bereits regstiert worden.<br>Bitte kontrollieren Sie Ihre Eingaben und versuchen Sie es ggf. erneut. [ERR_CODE_REGISTERED_OR_NOT_FOUND]"
}

1.3.2.7. Antwort-Schema bei Erfolg

```
error
```
– (Boolean) – Gibt an, ob die Registrierung erfolgreich war
```
message
```
– (Boolean) – Gibt eine benutzerfreundliche Nachricht aus

1.3.2.8.Antwort-Schema bei Misserfolg

```
error
```
– (Boolean) – Rückgabe true, wenn Fehler auftreten. Fehlermeldung wird mit folgendem string und einer benutzerfreundlichen Nachricht zur Verfügung gestellt:
```
message
```

Fehler Codes:

Fehlender Wert “code”:

Fehler bei der Datenübermittlung! Bitte versuchen Sie es in Kürze erneut. [ERR_EMPTY_CODE]

Fehlende Pflichtfelder

Fehler bei der Datenübermittlung! Folgende Felder fehlen:  [ERR_MISSING_FIELDS]

Pflichtfelder sind leer

Fehler bei der Datenübermittlung! Folgende Felder sind leer:  [ERR_EMTPY_FIELDS]

Der Code wird bereits verwendet oder wurde nicht gefunden

Fehler! Dieser Code wurde nicht gefunden oder ist bereits regstiert worden.
Bitte kontrollieren Sie Ihre Eingaben und versuchen Sie es ggf. erneut. [ERR_CODE_REGISTERED_OR_NOT_FOUND]

Interner Server Fehler in der Datenbank

Fehler bei der Datenübermittlung! Bitte versuchen Sie es in Kürze erneut. [ERR_UPDATE_FAILED]

2. Support

Damit Sie die Schnittstellen auch problemlos nutzen können, steht Ihnen unser kompetenter und freundlicher Support zur Verfügung.

millenium Werbeagentur GmbH
Agentur für visuelle Kommunikation
Hafenstraße 86
68159 Mannheim

E-Mail: info@millenium.de