Saltar a contenido

Primeros pasos

Guía mínima para realizar la primera llamada exitosa al API Gateway.

Antes de empezar

Obtenga de Kordata:

  1. URL base del gateway.
  2. API Key activa para su empresa.
  3. Confirmación de versión de API (v1).

Ver Ambientes.

Headers obligatorios

Header Valor Cuándo
x-api-key Su API Key Todas las rutas protegidas
x-api-version v1 Todas las peticiones
Content-Type application/json POST, PUT, PATCH con cuerpo

Primera petición

Sustituya TU_API_KEY y el identificador por valores válidos en su ambiente:

curl -X GET "https://qa-api.kordata.mx/marcas/1" \
  -H "x-api-key: TU_API_KEY" \
  -H "x-api-version: v1"

Respuesta esperada (estructura):

{
  "data": { },
  "meta": {
    "requestId": "…",
    "timestamp": "…",
    "latencyMs": 0,
    "version": "v1"
  }
}

Primera petición

Ejemplo orientativo — valide el body en Referencia Documentación API para la operación exacta:

curl -X POST "https://qa-api.kordata.mx/categorias" \
  -H "x-api-key: TU_API_KEY" \
  -H "x-api-version: v1" \
  -H "Content-Type: application/json" \
  -d "{\"nombreCategoria\":\"Mi categoría\",\"requiereReceta\":false}"

Probar sin escribir código

  1. Abra Referencia documentación API.
  2. En Authentication, configure ApiKeyAuth con su clave.
  3. Elija un endpoint, complete parámetros y pulse Send.

Siguiente lectura