API de Proveedor

La API de Proveedor permite gestionar configuraciones y ajustes específicos del proveedor en la plataforma Nilo. Estos endpoints ayudan a recuperar y gestionar información relacionada con el proveedor, como los códigos de cancelación para pedidos.

Entendiendo la Configuración del Proveedor

La configuración del proveedor en Nilo representa opciones de configuración y reglas de negocio específicas para cada proveedor:

• Tipos de Configuración
  • Códigos y razones de cancelación
  • Permisos de uso (Tienda/Proveedor)
  • Reglas y preferencias de negocio

Consideraciones Importantes

1. Control de Acceso: El acceso a la configuración del proveedor requiere permisos apropiados
2. Validación de Datos: Todas las configuraciones deben seguir los estándares de la plataforma
3. Contexto de Uso: Algunas configuraciones pueden ser específicas para tiendas o proveedores
4. Manejo de Respuestas: Manejo adecuado de errores para configuraciones faltantes o inválidas

Operaciones del Proveedor

Obtener Códigos de Cancelación

GET/supplier/cancelcodes

Recupera la lista de códigos de cancelación permitidos configurados para el proveedor. Estos códigos se utilizan al cancelar pedidos en la plataforma.

Parámetros de Respuesta

Parámetro	Tipo	Descripción
reason	string	Descripción de la razón de cancelación
code	string	Identificador único para el código de cancelación
usage	string	Indica quién puede usar el código (STORE/SUPPLIER)

Ejemplo de Respuesta

[
  {
    "reason": "Realizaré un nuevo pedido",
    "code": "NEW_ORDER",
    "usage": "STORE"
  }
]

Ejemplo de Uso

Javascript

const headers = {
  Authorization: "TU_TOKEN_DE_AUTORIZACION",
  "x-api-key": "TU_API_KEY",
};

fetch("https://api.nilo.com/supplier/cancelcodes", {
  method: "GET",
  headers: headers,
})
  .then((response) => response.json())
  .then((result) => console.log(result))
  .catch((error) => console.log("error", error));

Python

import requests

url = "https://api.nilo.com/supplier/cancelcodes"

headers = {
    'Authorization': 'TU_TOKEN_DE_AUTORIZACION',
    'x-api-key': 'TU_API_KEY'
}

response = requests.get(url, headers=headers)
print(response.text)

Seguridad

Autenticación

Todos los endpoints requieren dos tipos de autenticación:

• API Key en el encabezado: x-api-key
• Token de autorización en el encabezado: Authorization

Permisos Requeridos

Para los endpoints del proveedor, se requieren los siguientes permisos:

• Para leer códigos de cancelación: supplier/code.read