Crear clasificacion de cliente
Crea una nueva clasificación de cliente en el sistema. Permite organizar y categorizar a los clientes según diferentes criterios.
Entorno
Sección titulada «Entorno»URL Base: https://api.guarani.app
Endpoint
Sección titulada «Endpoint»POST /clientes-clasificacionesEjemplo de solicitud
Sección titulada «Ejemplo de solicitud»curl -X POST "https://api.guarani.app/clientes-clasificaciones" \ -H "Content-Type: application/json" \ -H "x-api-key: Bearer <access_token>" \ -d '{ "codigo": "01", "nombre": "CATEGORÍA EJEMPLO" }' | jqNota: Asegúrate de reemplazar
<access_token>con un token JWT válido proporcionado por el equipo Guarani. Importante:
Es imprescindible incluir un token de acceso válido en el encabezadox-api-keypara autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.
Encabezados de la Solicitud
Sección titulada «Encabezados de la Solicitud»| Encabezado | Valor | Descripción |
|---|---|---|
Content-Type | application/json | Indica que los datos se envían en formato JSON. |
x-api-key | Bearer <access_token> | Token de autenticación necesario para acceder al recurso. |
Descripción de Campos
Sección titulada «Descripción de Campos»| Parámetro | Tipo | Requerido | Tamaño | Descripción |
|---|---|---|---|---|
codigo | string | Sí | 9 | Código estructurado que identifica la clasificación de clientes. Ej:“01”, “01.01”, “01.01.001”. |
nombre | string | Sí | 100 | Nombre descriptivo de la clasificación de clientes. |
Ejemplo de respuesta
Sección titulada «Ejemplo de respuesta»{ "success": true, "codigo": "201", "message": "Recurso creado con éxito.", "data": { "id": "c5a0b11f-3011-4ae4-8a4b-1a0f2dfd032c", "codigo": "01", "nombre": "CATEGORÍA EJEMPLO" }}Descripción de Campos de Respuesta
Sección titulada «Descripción de Campos de Respuesta»Campos principales
Sección titulada «Campos principales»| Campo | Tipo | Descripción |
|---|---|---|
id | uuid | Identificador único de la clasificación generado por el sistema. |
codigo | string | Código estructurado que identifica la clasificación. Ej: “01”, “01.01”, “01.01.001”. |
nombre | string | Nombre descriptivo de la clasificación de clientes. |
Recursos adicionales
Sección titulada «Recursos adicionales»Para más información sobre posibles errores relacionados, consulta la sección errores.