---
title: 'Valide su payload'
description: 'Verifique el cuerpo que envía su integración contra esta documentación, antes de llamar a la API real.'
---

# Valide su payload

Antes de integrar de verdad, envíe el JSON que produce su sistema a `POST /api/validate` y reciba, campo por campo, lo que cumple con esta documentación y lo que no.

No requiere autenticación, no se guarda nada y no se crea ninguna transacción — la comparación se hace contra el mismo archivo que genera la página que usted está leyendo.

## Solicitud

```
POST https://developers.guper.co/api/validate
Content-Type: application/json
```

| Campo | Obligatorio | Descripción |
|---|---|---|
| `path` | sí¹ | La ruta que usted llama, como `/api/loyalty/rewardByOrder`. |
| `method` | no | Por omisión `POST`. |
| `endpoint` | sí¹ | Alternativa a `path`: la ruta de la página, como `loyalty/checkout/reward-by-order`. |
| `body` | sí | El cuerpo que envía su integración. |

¹ Envíe `path` **o** `endpoint`.

```json
{
    "path": "/api/loyalty/rewardByOrder",
    "body": {
        "interface": "generic",
        "storeId": "1",
        "client": { "name": "Tintín", "Entity": "Legal" },
        "items": [ { "id": "1", "name": "Bolsa", "quantity": "1", "price": 9900 } ]
    }
}
```

## Respuesta

```json
{
    "ok": false,
    "endpoint": "loyalty/checkout/reward-by-order",
    "title": "Reward by Order",
    "summary": { "unknown": 1, "missing": 0, "type": 1, "value": 0 },
    "findings": [
        {
            "path": "client.Entity",
            "kind": "unknown",
            "message": "Campo nao existe neste endpoint.",
            "didYouMean": "entityType"
        },
        {
            "path": "items[0].quantity",
            "kind": "type",
            "message": "Esperado integer, veio string.",
            "expected": ["integer"],
            "got": "string"
        }
    ]
}
```

`ok` es `true` cuando no hay ningún hallazgo. Cada hallazgo trae un `kind`:

| `kind` | Significa |
|---|---|
| `unknown` | El campo no existe en este endpoint. Cuando el nombre se parece a uno de los nuestros, `didYouMean` trae el correcto. |
| `missing` | Falta un campo obligatorio. |
| `type` | El tipo no corresponde — por ejemplo `"1"` donde se espera un entero. |
| `value` | El valor está fuera de la lista aceptada. El uso de mayúsculas equivocado (`"Legal"` en lugar de `legal`) se señala de forma explícita. |

La respuesta también trae `fields`, el inventario de todos los campos documentados de ese endpoint, indicando cuáles vinieron en su payload — útil para descubrir lo que **podría** estar enviando y no envía.

## Lo que no verifica

La verificación es de **forma**, contra la documentación. No conoce su organización, así que no le dirá si ese `storeId` existe, si la `interface` está registrada, ni si el importe en centavos está en la escala correcta. Un payload aprobado aquí todavía puede ser rechazado por la API por esos motivos.

## Por qué existe

Las claves de un objeto distinguen mayúsculas de minúsculas. Un campo con el nombre equivocado no se lee — y, por diseño, un campo desconocido se ignora en silencio, sin error. Una integración envió `client.Entity` durante dos meses creyendo que informaba el tipo de entidad del cliente: el campo se llama `entityType`, no se leía nada y nunca aparecía un error. Una prueba aquí, el primer día, habría mostrado ambos problemas.
