/feedback - Envio de errores y alertas de avisos
Este recurso le permite añadir errores y alertas a las publicaciones generadas desde Tokko Broker. Es el medio para que el broker conozca el estado de los avisos en su portal.
Generar feedback
La URL para realizar la solicitud es la siguiente:
http://www.tokkobroker.com/portals/simple_portal/api/v1/feedback/
Se debe agregar en los headers la key X-API-KEY, donde esta key es la misma que se utiliza en el listado de propiedades publicables y ademas, Content-Type con el valor application/json.
Esquema del cuerpo de la solicitud
{
"objects": [
{
"id": "str", // (opcional)
"publication_id": "str", // requerido
"status": STATUS_CHOICES, // requerido
"warnings": [{"message": "str"}], // (opcional)
"errors": [{"message": "str"}] // (opcional)
}
]
}
STATUS_CHOICES
- "3" significa que el aviso quedó correctamente publicado.
- "5" significa que el aviso quedó publicado, pero tiene alertas.
- "4" significa que el aviso no pudo ser publicado.
Campo | Descripción |
---|---|
id | ID del aviso dentro del portal. |
publication_id | ID de la publicación de Tokko Broker. |
status | Estado asociado a la publicación. |
warnings | Una lista de alertas asociadas a la publicación. |
errors | Una lista de errores asociados a la publicación. |
Ejemplo: marcar una propiedad publicable con un error
Para marcar una propiedad publicable con un error, puedes utilizar una solicitud curl como la siguiente:
curl -X POST 'http://www.tokkobroker.com/portals/simple_portal/api/v1/feedback/' \
--header 'X-API-KEY: $API_KEY' \
--header 'Content-Type: application/json' \
-d '{
"objects": [
{
"id": "test-550e82240300-e29b-41d4-a716-4466554400003",
"publication_id": "test-12931_a212_31235_212222222223x63489",
"status": "4",
"errors": [
{"message": "Title is too long. Max length is 100 characters."},
]
}
]
}'
Consideraciones
Es importante que los mensajes de alertas y errores sean en idioma español.
Respuesta:
La respuesta HTTP será vacía (código 201) y la propiedad publicable con ID test-12931_a212_31235_212222222223x63489 quedará con el error "Title is too long. Max length is 100 characters."
Consideraciones
La solicitud se procesa de manera asincrona.
Si se envian dos feedback para un mismo publication_id se considera el ultimo que se lee.
Updated about 1 year ago