Ir al contenido

API nativa de proveedores ​

GMShop Edge puede funcionar como un proveedor digital de bienes upstream para otra instancia de GMShop Edge. El protocolo nativo expone las operaciones de catálogo, pedido, canal de pago y recarga de billetera bajo /api/v1/supplier/*; es un protocolo de suministro para una tienda, no una API de pasarela de pago.

Activar y emitir credenciales. ​

Habilite la API del proveedor en la configuración de administración, y luego cree una clave de API para la cuenta del cliente que realizará compras en esta tienda. La clave secreta solo se muestra al momento de su creación y se almacena encriptada. Las claves pueden ser revocadas, y se puede establecer una URL de callback permitida opcional para restringir dónde se envían las notificaciones de cumplimiento.

La instancia de GMShop Edge, que consume intensamente, selecciona el adaptador de proveedor gmshop_edge y almacena el ID de clave y el secreto emitido en su configuración de ejecución encriptada.

Solicitud de firma ​

Todas las solicitudes deben utilizar HTTPS sin especificar un puerto y enviar:

  • GMShop-Edge-Api-Key: ID de clave emitida.
  • GMShop-Edge-Timestamp: marca de tiempo Unix de 10 dígitos, expresada en segundos.
  • GMShop-Edge-Nonce: valor alfanumérico/con guiones único de 16-100 caracteres.
  • GMShop-Edge-Signature: resumen HMAC-SHA256 en hexadecimal y minúsculas.

Construye el payload de firma uniendo estos valores con caracteres de nueva línea:

text
UPPERCASE_HTTP_METHOD
PATH_WITH_RAW_QUERY
UNIX_TIMESTAMP
NONCE
SHA256_HEX_OF_RAW_BODY

Calcular el HMAC-SHA256 sobre ese payload utilizando el secreto API emitido. El servidor acepta una desviación de tiempo de hasta 60 segundos y almacena cada nonce como un recibo de reuso. Reutilizar una nonce devuelve un conflicto. Los límites de velocidad actuales son 120 solicitudes por clave por minuto y 300 solicitudes por usuario por minuto.

Endpoints ​

OperaciónHTTPRuta
Comprobar credencialesPOST/api/v1/supplier/ping
Listar categoríasGET/api/v1/supplier/categories
Listar productosGET/api/v1/supplier/products
Consultar un productoGET/api/v1/supplier/products/{productId}
Crear un pedidoPOST/api/v1/supplier/orders
Consultar un pedidoGET/api/v1/supplier/orders/{orderId}
Cancelar un pedidoPOST/api/v1/supplier/orders/{orderId}/cancel
Listar canales de pagoGET/api/v1/supplier/payment-channels
Crear una recargaPOST/api/v1/supplier/topups
Consultar una recargaGET/api/v1/supplier/topups/{id}

La creación de pedidos y las operaciones de recarga son idempotentes. Al reintentar una solicitud incierta, mantenga la misma referencia de idempotencia; no cree un nuevo pedido de proveedor simplemente porque el cliente expiró.

Referencia de la API ​

Una instancia desplegada redirige /openapi a su referencia API interactiva. El repositorio también publica la documentación completa de OpenAPI YAML, que abarca la autenticación, la gestión de pedidos, las notificaciones de los proveedores, la administración, el soporte web y el protocolo nativo de los proveedores.