Docs API | CODE24

1.Interfaccia API

1.1.Introduzione

CODE24 vi fornisce un'integrazione professionale tramite interfaccia API, che permette i seguenti servizi web:

Controllo del codice
Registrazione di un prodotto
Modifica dei dati del cliente
Estensione di un termine

A tal fine, CODE24 offre ai suoi clienti un'interfaccia REST che può essere chiamata tramite varie richieste. Offriamo le seguenti richieste per questo:

HTTP
cURL
PHP

Questo permette a CODE24 di offrire ai suoi clienti l'interfaccia utente
per controllare, registrarsi, cambiare i dati, rinnovare completamente da soli e per integrarlo in modo ottimale nel frontend del sito web.

L'interfaccia WebService risponde con un oggetto JSON che può essere valutato automaticamente dal lato del cliente - per esempio, per riportare errori di validazione.

1.2.Regole generali

L'API WebService viene richiamata tramite il seguente URL. Si prega di notare il protocollo HTTPS.
Tutti i parametri sono trasferiti via HTTP-POST.

https://code24.de

1.3.Servizi web

1.3.1.1° Esame del codice

Puoi controllare i nostri numeri chiave direttamente online e ricevere immediatamente un messaggio se il codice è valido o no o se è già stato registrato.

POST /?keyfinder_check&json_response

1.3.1.1.Campi del post (form-data)

```
codice
```
Necessario. (Stringa) - controlla il codice (esempio: A160045)

1.3.1.2.Parametro della stringa di query

```
cerca-chiave
```
– Necessario. (Stringa) - avvia l'azione per controllare il codice
```
risposta json
```
– Richiede. (Stringa) - invia JSON invece di HTML

1.3.1.3.Esempio di chiamata HTTP

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

1.3.1.4.Esempio di chiamata cURL

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

1.3.1.5.Esempio di chiamata PHP

"https://code24.de/?keyfinder_check=&json_response=",
  CURLOPT_RETURNTRANSFER => vero,
  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);

se ($err) {
  echo "errore cURL #:" . $err;
} else {
  echo $response;
}

1.3.1.6.Esempio di risultato oggetto JSON

{
  "errore": falso,
  "successo": vero,
  "registrato": falso,
  "periodo": 0
}

1.3.1.7. Schema di risposta in caso di successo

```
successo
```
- (booleano) - Indica se il controllo ha avuto successo (il codice esiste o no).
```
registrato
```
- (Booleano) - Indica se il codice è già stato registrato o no.
```
periodo
```
- (Int) - Indica il periodo del codice

1.3.1.8.Schema di risposta in caso di guasto

```
errore
```
- (Booleano) - Restituisce true se si verificano errori. Il messaggio di errore è fornito con la seguente stringa e un messaggio di facile comprensione:
```
messaggio
```

1.3.2.2. registrazione del codice

Puoi registrare il codice controllato direttamente online. Per questo devono essere passati dei parametri appropriati.

POST /?keyfinder_register&json_response

1.3.2.1.Campi postali

```
registratore di chiavi
```
– Necessario. (String) - Il valore è opzionale. Avvia la sessione di registrazione.
```
codice
```
– Necessario. (Stringa) - Il codice da registrare (Esempio:
```
A160045
```
)
```
strada
```
– Necessario. (Stringa) - Indirizzo del cliente Street e Numero civico
```
zip
```
– Necessario. (Stringa) - Indirizzo del cliente Codice postale
```
città
```
– Necessario. (Stringa) - Indirizzo del cliente Città
```
paese
```
– Necessario. (Stringa) - Indirizzo del cliente Paese
```
e-mail
```
– Necessario. (Stringa) - Indirizzo e-mail del cliente
```
saluto
```
– Necessario. (Stringa) - Indirizzo del cliente Saluto
```
nome
```
– Necessario. (Stringa) - Indirizzo del cliente Nome
```
loadname
```
– Necessario. (Stringa) - Indirizzo del cliente Cognome
```
telefono
```
– Necessario. (Stringa) - Indirizzo del cliente Telefono
```
periodo
```
– Necessario. (Int) - Indirizzo del cliente Termine (Assegnato automaticamente dal server, di default 1 anno)

1.3.2.2.Parametro della stringa di query

```
registratore di chiavi
```
– Necessario. (String) - avvia l'azione per registrare il codice
```
risposta json
```
- Brinforzato. (Stringa) - invia JSON invece di HTML

1.3.2.3.Esempio di chiamata 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.Esempio di chiamata 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.Esempio di chiamata 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.Esempio di risultato oggetto JSON

Sul successo: HTTP 200 OK

{
  "errore": falso,
  "messaggio": "È stato registrato con successo".
}

Su errore: Errore interno del server HTTP 500

{
    "error": true,
    "message": "Errore! Questo codice non \u00e8 stato trovato o \u00e8 gi\u00e0 stato cancellato.<br>Si prega di controllare le voci e riprovare se necessario. [ERR_CODE_REGISTERED_OR_NOT_FOUND]"
}

1.3.2.7. Schema di risposta in caso di successo

```
errore
```
- (Booleano) - Indica se la registrazione ha avuto successo.
```
messaggio
```
- (booleano) - Emette un messaggio di facile comprensione

1.3.2.8.Schema di risposta in caso di guasto

```
errore
```
- (Booleano) - Restituisce true se si verificano errori. Il messaggio di errore è fornito con la seguente stringa e un messaggio di facile comprensione:
```
messaggio
```

Codici di errore:

Valore mancante "codice

Errore durante la trasmissione dei dati! Si prega di riprovare a breve. [CODICE_ERRORE_VUOTO]

Campi obbligatori mancanti

Errore durante la trasmissione dei dati! Mancano i seguenti campi:  [ERR_MISSING_FIELDS]

I campi obbligatori sono vuoti

Errore durante la trasmissione dei dati! I seguenti campi sono vuoti:  [ERR_EMTPY_FIELDS]

Il codice è già in uso o non è stato trovato

Errore! Questo codice non è stato trovato o è già stato registrato.
Si prega di controllare le voci e riprovare se necessario. [ERR_CODE_REGISTERED_OR_NOT_FOUND]

Errore interno del server nel database

Errore durante la trasmissione dei dati! Si prega di riprovare a breve. [ERR_UPDATE_FAILED]

2. Supporto

Affinché anche voi possiate utilizzare le interfacce senza problemi, il nostro supporto competente e amichevole è a vostra disposizione.

millenium advertising agency GmbH
Agenzia per la comunicazione visiva
Strada del porto 86
68159 Mannheim

E-mail: info@millenium.de