Docs API | CODE24

1.Interfaz API

1.1.Introducción

CODE24 le ofrece una integración profesional a través de la interfaz API, que permite los siguientes servicios web:

Comprobación del código
Registro de un producto
Cambio de los datos del cliente
Prórroga de un plazo

Para ello, CODE24 pone a disposición de sus clientes una interfaz REST a la que se puede acceder a través de diversas solicitudes. Para ello, ofrecemos las siguientes peticiones:

HTTP
cURL
PHP

Esto permite a CODE24 ofrecer a sus clientes la interfaz de usuario
para comprobar, registrar, modificar los datos, renovar completamente por sí mismo e integrarlo de forma óptima en el frontend del sitio web.

La interfaz WebService responde con un objeto JSON que puede ser evaluado automáticamente por el cliente, por ejemplo, para informar de los errores de validación.

1.2.Normas generales

La API de WebService se llama a través de la siguiente URL. Tenga en cuenta el protocolo HTTPS.
Todos los parámetros se transfieren a través de HTTP-POST.

https://code24.de

1.3.Servicios web

1.3.1.1er. Examen del Código

Puede comprobar nuestros números clave directamente en línea y recibir inmediatamente un mensaje sobre si el código es válido o no o si ya ha sido registrado.

POST /?keyfinder_check&json_response

1.3.1.1.Campos de la entrada (datos del formulario)

```
código
```
Se necesita. (Cadena) - comprueba el código (ejemplo: A160045)

1.3.1.2.Parámetro de la cadena de consulta

```
keyfinder_check
```
– Se necesita. (Cadena) - inicia la acción para comprobar el código
```
json_response
```
– Requiere. (Cadena) - envía JSON en lugar de HTML

1.3.1.3.Ejemplo de llamada HTTP

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

1.3.1.4.Ejemplo de llamada cURL

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

1.3.1.5.Ejemplo de llamada PHP

Se trata de un problema de salud pública, pero no se trata de un problema de salud pública.

$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);

si ($err) {
  echo "cURL Error #:" . $err;
} si no {
  echo $response;
}

1.3.1.6.Ejemplo de objeto JSON de resultado

{
  "error": falso,
  "éxito": verdadero,
  "registrado": falso,
  "período": 0
}

1.3.1.7. Esquema de respuesta en caso de éxito

```
éxito
```
- (Booleano) - Indica si la comprobación ha tenido éxito (el código existe o no).
```
registrado
```
- (Booleano) - Indica si el código ya ha sido registrado o no.
```
período
```
- (Int) - Indica el periodo del código

1.3.1.8.Esquema de respuesta en caso de fallo

```
error
```
- (Booleano) - Devuelve true si se producen errores. El mensaje de error se proporciona con la siguiente cadena y un mensaje amigable:
```
mensaje
```

1.3.2.2. registro de códigos

Puede registrar el código comprobado directamente en línea. Para ello, hay que pasar los parámetros correspondientes.

POST /?keyfinder_register&json_response

1.3.2.1.Campos de destino

```
keyfinder_register
```
– Se necesita. (Cadena) - El valor es opcional. Inicia la sesión de registro.
```
código
```
– Se necesita. (Cadena) - El código a registrar (Ejemplo:
```
A160045
```
)
```
en la calle
```
– Se necesita. (Cadena) - Dirección del cliente Calle y Número de casa
```
zip
```
– Se necesita. (Cadena) - Dirección del cliente Código postal
```
ciudad
```
– Se necesita. (Cadena) - Dirección del cliente Ciudad
```
país
```
– Se necesita. (Cadena) - Dirección del cliente País
```
correo electrónico
```
– Se necesita. (Cadena) - Dirección del cliente Correo electrónico
```
saludo
```
– Se necesita. (Cadena) - Dirección del cliente Saludo
```
nombre
```
– Se necesita. (Cadena) - Dirección del cliente Nombre
```
loadname
```
– Se necesita. (Cadena) - Dirección del cliente Apellido
```
teléfono
```
– Se necesita. (Cadena) - Dirección del cliente Teléfono
```
período
```
– Se necesita. (Int) - Dirección del cliente Término (Asignado automáticamente por el servidor, por defecto 1 año)

1.3.2.2.Parámetro de la cadena de consulta

```
keyfinder_register
```
– Se necesita. (Cadena) - inicia la acción para registrar el código
```
json_response
```
- Bforzada. (Cadena) - envía JSON en lugar de HTML

1.3.2.3.Ejemplo de llamada 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.Ejemplo de llamada 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.Ejemplo de llamada 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.Ejemplo de objeto JSON de resultado

Sobre el éxito: HTTP 200 OK

{
  "error": falso,
  "mensaje": "Se ha registrado con éxito".
}

En el error: Error interno del servidor HTTP 500

{
    "error": true,
    "message": "\u00a1Error! Este c\u00f3digo no se ha encontrado o ya se ha eliminado.<br>Por favor, compruebe sus entradas y vuelva a intentarlo si es necesario. [ERR_CODE_REGISTERED_OR_NOT_FOUND]"
}

1.3.2.7. Esquema de respuesta en caso de éxito

```
error
```
- (Booleano) - Indica si el registro fue exitoso.
```
mensaje
```
- (Booleano) - Muestra un mensaje fácil de usar

1.3.2.8.Esquema de respuesta en caso de fallo

```
error
```
- (Booleano) - Devuelve true si se producen errores. El mensaje de error se proporciona con la siguiente cadena y un mensaje amigable:
```
mensaje
```

Códigos de error:

Valor faltante "código

Error durante la transmisión de datos. Por favor, inténtelo de nuevo en breve. [ERR_EMPTY_CODE]

Faltan campos obligatorios

Error durante la transmisión de datos. Faltan los siguientes campos:  [ERR_MISSING_FIELDS]

Los campos obligatorios están vacíos

Error durante la transmisión de datos. Los siguientes campos están vacíos:  [ERR_EMTPY_FIELDS]

El código ya está en uso o no se ha encontrado

¡Error! Este código no se ha encontrado o ya se ha registrado.
Por favor, compruebe sus entradas y vuelva a intentarlo si es necesario. [ERR_CODE_REGISTERED_OR_NOT_FOUND]

Error interno del servidor en la base de datos

Error durante la transmisión de datos. Por favor, inténtelo de nuevo en breve. [ERR_UPDATE_FAILED]

2. Soporte

Para que usted también pueda utilizar las interfaces sin problemas, tiene a su disposición nuestro competente y amable servicio de asistencia.

agencia de publicidad millenium GmbH
Agencia de comunicación visual
Carretera del puerto 86
68159 Mannheim

Correo electrónico: info@millenium.de