Saltar al contenido principal

Obtener credenciales por URL con el API

Si su integración necesita conectarse a varias tiendas de Zauru y no quiere guardar a mano las credenciales de cada una, este endpoint le resuelve el problema: usted envía la URL de la tienda y Zauru le devuelve el email y el token del usuario de e-commerce correspondiente. Es especialmente útil para servicios centralizados de sincronización que administran muchas entidades.

Funcionamiento

Cuando un sistema externo necesita conectarse a Zauru pero no conoce qué usuario y token utilizar, puede consultar este endpoint enviando el URL de la tienda. Zauru busca en sus variables de entidad el URL registrado y devuelve el email y token del usuario de e-commerce asociado.

Autenticación

No importa que su servicio no conozca todavía el email ni el token del usuario de Zauru: este endpoint se identifica con su propio token de autorización.

Este endpoint no utiliza la autenticación estándar por X-User-Email y X-User-Token. En su lugar, requiere un token de autorización único que debe enviarse como parámetro auth_token.

El valor del token se configura en la variable de entorno ECOMMERCE_AUTH_TOKEN del servidor Zauru. Solicítalo a tu implementador para poder utilizar el endpoint.

Parámetros

ParámetroTipoDescripción
auth_tokenstringToken de autorización para acceder al endpoint. Debe coincidir con ECOMMERCE_AUTH_TOKEN
prod_ecommerce_urlstringURL de la tienda en producción. Se busca una variable ecommerce_production_url con este valor en alguna entidad
tests_ecommerce_urlstringURL de la tienda en pruebas. Se busca una variable ecommerce_production_url con este valor en alguna entidad

Se debe enviar al menos uno de los dos parámetros de URL (prod_ecommerce_url o tests_ecommerce_url).

Lógica de búsqueda

  1. Si se envía prod_ecommerce_url, se busca una variable con nombre ecommerce_production_url y valor igual al URL enviado.
  2. Si se envía tests_ecommerce_url, se busca una variable con nombre ecommerce_production_url y valor igual al URL enviado.
  3. Si se encuentra la variable, se obtiene la entidad (Entity) a la que pertenece.
  4. De esa entidad, se busca la variable ecommerce_requests_user_id que contiene el ID del usuario de e-commerce.
  5. Con ese ID, se obtiene el usuario y se devuelve su email y authentication_token.

Respuesta exitosa

{
"user": "ecommerce@empresa.com",
"token": "XSDFKK09238487DLFS"
}

Respuesta de error

Si no se encuentra el URL o no hay usuario configurado:

{
"error": "User not found"
}

Con código de estado HTTP 404 Not Found.

Ejemplo de uso

curl -v \
-H "Accept: application/json" \
-H "Content-type: application/json" \
"https://app.zauru.com/ecommerce/ecommerce_requests/credentials_based_on_url.json?auth_token=jHr2PZ75sJHxpb2HGAo7&prod_ecommerce_url=https://mitienda.com"

Esto devolverá un JSON similar a este:

{
"error": "User not found"
}

O usando la URL de pruebas:

curl -v \
-H "Accept: application/json" \
-H "Content-type: application/json" \
"https://app.zauru.com/ecommerce/ecommerce_requests/credentials_based_on_url.json?auth_token=jHr2PZ75sJHxpb2HGAo7&tests_ecommerce_url=https://staging.mitienda.com"

Esto devolverá un JSON similar a este:

{
"error": "User not found"
}

Caso de uso

Este endpoint es particularmente útil para sistemas de integración que necesitan conectarse a múltiples entidades de Zauru sin tener que almacenar manualmente las credenciales de cada una. Por ejemplo, un servicio de sincronización centralizado puede:

  1. Conocer la URL de la tienda (que es pública)
  2. Consultar este endpoint para obtener las credenciales de Zauru
  3. Usar las credenciales obtenidas para las llamadas subsiguientes al API de e-commerce

Dependencias de configuración

Para que este endpoint funcione correctamente, la entidad debe tener configuradas las siguientes variables:

VariableDescripción
ecommerce_production_urlLa URL de producción de la tienda, configurada en configuración avanzada
ecommerce_requests_user_idEl ID del usuario de e-commerce, configurado en configuración avanzada

Con esto, resolver credenciales deja de ser trabajo manual: cada vez que integre una tienda nueva, solo debe registrar sus variables de entidad y este endpoint entregará el usuario y el token correctos.

¿Le fue útil esta guía?