Docs API | CODE24

1.Interface API

1.1.Introduction

CODE24 met à votre disposition une intégration professionnelle via une interface API qui permet les services web suivants :

Vérification du code
Enregistrement d'un produit
Modification des données du client
Prolongation d'une durée

Pour cela, CODE24 propose à ses clients une interface REST qui peut être appelée via différentes requêtes. Nous proposons les requêtes suivantes :

HTTP
cURL
PHP

Ainsi, CODE24 permet à ses clients d'utiliser l'interface utilisateur
pour la vérification, l'enregistrement, la modification des données, le renouvellement, et de les intégrer de manière optimale dans le frontend du site web.

L'interface WebService répond par un objet JSON qui peut être évalué de manière automatisée du côté du client - par exemple pour signaler des erreurs de validation.

1.2.Règles générales

L'API WebService est accessible via l'URL suivante. Veuillez tenir compte du protocole HTTPS.
Tous les paramètres sont transmis via HTTP-POST.

https://code24.de

1.3.Services web

1.3.1.1er examen du code

Vous pouvez vérifier nos numéros de clés directement en ligne et recevoir immédiatement un message vous indiquant si le code est valable ou non ou s'il est déjà enregistré.

POST /?keyfinder_check&json_response

1.3.1.1.Champs de courrier (form-data)

```
code
```
Nécessaire. (chaîne) - vérifie le code (exemple : A160045)

1.3.1.2.Paramètre de chaîne de requête

```
keyfinder_check
```
– Nécessaire. (Chaîne) - lance l'action pour vérifier le code
```
json_response
```
– Nécessite. (chaîne) - envoie le JSON au lieu du HTML

1.3.1.3.Exemple d'appel HTTP

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

1.3.1.4.Exemple d'appel cURL

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

1.3.1.5.Exemple d'appel PHP

"https://code24.de/?keyfinder_check=&json_response=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_TIMEOUT => 5,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "code=A160045",
  CURLOPT_HTTPHEADER => tableau(
    "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.Exemple de résultat JSON Object

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

1.3.1.7. Schéma de réponse en cas de succès

```
succès
```
- (booléen) - Indique si la vérification a réussi (le code existe ou non)
```
enregistré
```
- (booléen) - Indique si le code a déjà été enregistré ou non
```
période
```
- (Int) - Indique la période du code

1.3.1.8.Schéma de réponse en cas d'échec

```
erreur
```
- (booléen) - renvoie true si une erreur se produit. Le message d'erreur est fourni avec la chaîne de caractères suivante et un message convivial :
```
message
```

1.3.2.2. enregistrement du code

Vous pouvez enregistrer le code vérifié directement en ligne. Pour cela, il faut passer les paramètres correspondants.

POST /?keyfinder_register&json_response

1.3.2.1.Champs de courrier

```
keyfinder_register
```
– Nécessaire. (Chaîne) - La valeur est facultative. Démarre la session d'enregistrement.
```
code
```
– Nécessaire. (Chaîne) - Le code à enregistrer (exemple :
```
A160045
```
)
```
street
```
– Nécessaire. (Chaîne) - Adresse du client Rue et Numéro de maison
```
zip
```
– Nécessaire. (Chaîne) - Adresse du client NPA
```
city
```
– Nécessaire. (Chaîne) - Adresse du client Ville
```
country
```
– Nécessaire. (Chaîne) - Adresse du client Pays
```
email
```
– Nécessaire. (Chaîne) - Adresse du client E-mail
```
salutation
```
– Nécessaire. (Chaîne) - Adresse du client Titre
```
premier nom
```
– Nécessaire. (Chaîne) - Adresse du client Prénom
```
nom de la charge
```
– Nécessaire. (Chaîne) - Adresse du client Nom de famille
```
phone
```
– Nécessaire. (Chaîne) - Adresse du client Téléphone
```
période
```
– Nécessaire. (Int) - Adresse du client Durée (Attribué automatiquement par le serveur, 1 an par défaut)

1.3.2.2.Paramètre de chaîne de requête

```
keyfinder_register
```
– Nécessaire. (Chaîne) - lance l'action pour enregistrer le code
```
json_response
```
- Bde l'entreprise. (chaîne) - envoie le JSON au lieu du HTML

1.3.2.3.Exemple d'appel 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.Exemple d'appel 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.Exemple d'appel 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.Exemple de résultat JSON Object

Sur la réussite : HTTP 200 OK

{
  "error" : false,
  "message" : "A été enregistré avec succès".
}

On error : HTTP 500 Erreur interne du serveur

{
    "error": true,
    "message": "Erreur ! Ce code n'a pas \u00e9t\u00e9 trouv\u00e9 ou a d\u00e9j\u00e0 \u00e9t\u00e9 enregistr\u00e9.<br>Veuillez v\u00e9rifier vos saisies et r\u00e9essayer si n\u00e9cessaire. [ERR_CODE_REGISTERED_OR_NOT_FOUND]"
}

1.3.2.7. Schéma de réponse en cas de succès

```
erreur
```
- (booléen) - Indique si l'enregistrement a été effectué avec succès
```
message
```
- (Boolean) - Émet un message convivial

1.3.2.8.Schéma de réponse en cas d'échec

```
erreur
```
- (booléen) - renvoie true si une erreur se produit. Le message d'erreur est fourni avec la chaîne de caractères suivante et un message convivial :
```
message
```

Codes d'erreur :

Valeur "code" manquante

Erreur lors de la transmission des données ! Veuillez réessayer dans quelques instants. [ERR_EMPTY_CODE]

Champs obligatoires manquants

Erreur lors de la transmission des données ! Les champs suivants sont manquants :  [ERR_MISSING_FIELDS]

Les champs obligatoires sont vides

Erreur lors de la transmission des données ! Les champs suivants sont vides :  [ERR_EMTPY_FIELDS]

Le code est déjà utilisé ou n'a pas été trouvé

Erreur ! Ce code n'a pas été trouvé ou a déjà été enregistré.
Veuillez vérifier vos saisies et réessayer si nécessaire. [ERR_CODE_REGISTERED_OR_NOT_FOUND]

Erreur de serveur interne dans la base de données

Erreur lors de la transmission des données ! Veuillez réessayer sous peu. [ERR_UPDATE_FAILED]

2. Support

Pour que vous puissiez utiliser les interfaces sans problème, notre support compétent et sympathique est à votre disposition.

millenium Werbeagentur GmbH
Agence de communication visuelle
86, rue du Port
68159 Mannheim

Courrier électronique : info@millenium.de