Integración de la extensión BCome en tu e-commerce
BCome ha desarrollado un script personalizado para integrar sin problemas métricas clave en tu plataforma. La API te permite integrar métricas de BCome directamente en tu sistema, lo que ofrece flexibilidad sin depender del widget proporcionado por BCome. Esta guía describe los pasos para instalar y configurar manualmente la extensión API.
Limitaciones
La API se puede consumir desde cualquier plataforma o framework ya que devuelve datos en formato JSON, lo que garantiza la compatibilidad con la mayoría de los lenguajes de programación.
Autentificación
La autenticación se gestiona mediante una API Key, generada de forma exclusiva para cada usuario. Si la clave API se ve comprometida, se puede restablecer después de notificar al cliente para garantizar un acceso ininterrumpido. Para volver a generar tu clave API, simplemente ponte en contacto con el equipo de BCome y te ayudarán de inmediato.
Cómo empezar
Empieza a mejorar tu e-commerce integrando nuestra API. Esto te permitirá automatizar procesos y optimizar la gestión de datos de forma eficiente.
Cómo implementar el script
La API hace que el proceso de integración sea muy flexible. Sigue estos pasos:
Paso 01 | Obtener tu API Key
Inicia sesión en tu cuenta, ve a la sección Digitalización → Integración y copia tu API Key única.
Paso 02 | Realizar la llamada a la API
Realiza una solicitud GET a la URL especificada proporcionada por BCome. Tendrás que pasar dos parámetros de consulta:
- hostname: debe estar registrado y aprobado en tu cuenta como host permitido.
- references: especifica los elementos para los que desea recuperar datos.
Además, incluye un encabezado de seguridad llamado securehash, que debes generar. A continuación, se proporcionan instrucciones para crear este hash.
Paso 03 | Autentificar la API
Autentica tu llamada API generando un hash, que concatena el nombre de host y los parámetros de referencia, usando tu clave API. Este hash garantiza una comunicación segura y evita la manipulación.
Para mantener la seguridad, evita exponer tu API Key y utiliza siempre HTTPS para la transmisión de datos cifrados.
Paso 04 | Probar la integración
Ejecuta pruebas para verificar que la API esté funcionando correctamente. Asegúrate de que se estén transfiriendo todos los datos y de que no haya errores.
Paso 05 | Entender los datos devueltos
La API devuelve datos específicos en función de tu plan e integración. Cada punto de datos se relaciona con métricas de sostenibilidad como trazabilidad, gestión del ciclo de vida del producto (PLM), evaluación del ciclo de vida (LCA), indicadores de economía circular (CEI) y más.
📍 Nota: Si faltan determinados puntos de datos, es posible que no estén habilitados en tu plan actual. Para acceder a funciones adicionales, asegúrate de que estén activadas o comunícate con el servicio de asistencia.
Seguridad y Request
Para mayor seguridad, genera un token utilizando el algoritmo sha512 y pasalo en el encabezado securehash. Sigue estos pasos para crear el token:
1. Crear el String to Encrypt
Concatena el nombre de host, el símbolo + y el parámetro de referencias en una cadena única. Ejemplo: [nombre de host]+[referencias].
2. Cifrar la cadena con sha512
Cifra esta cadena usando el algoritmo sha512 y tu API Key como clave de cifrado. Aquí hay un ejemplo en JavaScript:
3. Ejemplo de PHP
A continuación hay un ejemplo de PHP para generar el hash, ya que PHP es uno de los lenguajes de programación más comunes:
Este proceso garantiza que tus solicitudes de API sean seguras y estén debidamente autenticadas. Si es necesario, se pueden proporcionar ejemplos en otros lenguajes de programación.
Cómo probar la integración de API sin escribir código
Si desea realizar pruebas usando Postman u otro cliente sin codificar todavía, puede generar el securehash usando este sitio web: HMAC Generator.
Paso 01 | Generar el Securehash
Para probar la API sin codificar, use el generador HMAC aquí. Selecciona el algoritmo de hash (p. ej., SHA-512), ingresa hostname+references e ingresa la API Key como secreto. Esto generará el securehash.
Paso 02 | Configurar los parámetros de solicitud API
Especifica la URL de la API e incluye el hostname y las references como parámetros. Agregua el securehash como valor en el encabezado de la solicitud para autenticar.
Paso 03 | Obtener la respuesta de la API
Cuando se ejecuta la solicitud de API, se devolverá un objeto JSON que contiene varios objetos anidados. Estos detallarán los resultados en función de los parámetros proporcionados:
- PLM
- LCA
- Eco-Score
- CEI
- Others
La siguiente imagen proporciona un ejemplo completo de la respuesta de la API:
Además, aquí hay un ejemplo de llamada funcional usando CURL:
curl --location 'https://api.bcome.biz/api/articles/externalApi?hostname=www.demo.com&references=GAKNODRAT6270WW56' \
--header 'securehash: a5c5cd2791a73f75f04ae46b942198d4b738d3e7948b02aaf2070457b327c1c8dd6439318b4e81e1210a0fef2b953e74dcfae0761e09ec724ba89df0ef3634f9'Artículos relacionados
Comunicación de parámetros via API: Guía del usuario para una integración eficiente