Configuración de Mirakl Connector
Define your integration variables.
Antes de instalar el conector, prepara un archivo con las siguientes variables.
En nuestro repositorio, proporcionamos una muestra de un archivo de configuración que puedes copiar y renombrar a .env.
Configuración general
| Parámetro | Descripción |
|---|
| APP_SECRET | A generar. Se usa comúnmente para añadir más entropía a las operaciones relacionadas con la seguridad. Encontrarás más información en la documentación de Symfony. |
| OPERATOR_PASSWORD | A generar. Se utiliza para proteger las peticiones a la API que el conector expone. Establece este valor para el encabezado X-AUTH-TOKEN cuando llames a la API. |
| DATABASE_URL | La URL de la conexión a tu base de datos. Encontrarás más información en la documentación de Doctrine. Por ejemplo,pgsql://symfony:symfony@db:5432/symfony?charset=UTF-8. |
| MESSENGER_TRANSPORT_DSN | El transporte que se utiliza para el sistema de colas. Para conocer los transportes aceptados, consulta la documentación de Symfony Messenger. Por ejemplo, amqp://guest:guest@localhost:5672/%2f/messages. El valor predeterminado es doctrine://default. |
| STRIPE_CLIENT_SECRET | La clave secreta de tu API de Stripe está en configuración de claves de API. Te recomendamos que crees una clave de API específica para el conector. No se aceptan claves restringidas. |
| MIRAKL_HOST_NAME | Nombre de host de tu instancia de Mirakl. Por ejemplo, https://mymarketplace.mirakl.net. |
| MIRAKL_API_KEY | La llave de operador de Mirakl. Se puede generar como un operador de Mirakl en la configuración de la API. Recomendamos que se cree un operador específico para el conector. |
Onboarding
| Parámetro | Descripción |
|---|
| REDIRECT_ONBOARDING | El conector redirige al vendedor a esta URL después de terminar de crear su cuenta en Stripe. El valor predeterminado es $MIRAKL_HOST_NAME/mmp/shop/account/shop. |
| BASE_HOST | El dominio del servidor que aloja tu conector. Por ejemplo, stripe-mirakl.example.com. |
| SCHEME | El esquema empleado por el servidor de tu base. Valores predeterminados en https. |
| STRIPE_SELLERS_WEBHOOK_SECRET | El secreto de tu webhook de Stripe, que está disponible en la configuración del webhook de Connect cuando se añade al punto de conexión, consulta la siguiente información. |
| MIRAKL_CUSTOM_FIELD_CODE | Código del campo personalizado que debes añadir, consulta la siguiente información. El valor predeterminado es stripe-url. |
Añade un punto de conexión del webhook de Stripe a tu cuenta conectada
- Ve a la configuración del webhook.
- Añade un punto de conexión de webhook.
- Haz que la URL sea
<BASE_HOST>/api/public/webhook/sellers. - Selecciona Escuchar eventos de cuentas conectadas:
- Añade
account.updated a Eventos que hay que enviar - Haz clic en Añadir punto de conexión.
- Usa el secreto del webhook para la variable de entorno
STRIPE_SELLERS_WEBHOOK_SECRET.
Añadir un campo personalizado a las tiendas de Mirakl
- Inicia sesión en tu back office de Mirakl como un operador.
- Ve a Configuración > Parámetros avanzados > Tiendas.
- Ve a la pestaña Campos personalizados.
- Usa los siguientes valores crear un campo nuevo:
| Parámetro | Descripción |
|---|
| Código | Usa stripe-url salvo que hayas elegido un clave diferente en tu archivo de entorno. |
| Tipo | Link |
| Permisos de las tiendas | Read only |
| Campo obligatorio | No |
Pagos
| Parámetro | Descripción |
|---|
| PAYMENT_METADATA_COMMERCIAL_ORDER_ID | Clave de metadatos utilizada en Cargos para transmitir el ID de pedido comercial de Mirakl. El valor predeterminado es mirakl_commercial_order_id. |
| ENABLE_PRODUCT_PAYMENT_SPLIT | Enable the payment split workflow for product orders. Defaults to false. |
| ENABLE_SERVICE_PAYMENT_SPLIT | Enable the payment split workflow for service orders. Defaults to false. |
| ENABLE_PRODUCT_PAYMENT_REFUND | Enable the payment refund workflow for product orders. Defaults to false. |
| ENABLE_SERVICE_PAYMENT_REFUND | Enable the payment refund workflow for service orders. Defaults to false. |
| STRIPE_OPERATOR_WEBHOOK_SECRET | El secreto de tu webhook de Stripe, que está disponible en la configuración del webhook de la cuenta cuando se añade al punto de conexión, consulta la siguiente información. |
Añade un punto de conexión del webhook de Stripe a tu cuenta
- Ve a la configuración del webhook.
- Añade un punto de conexión de webhook a tu cuenta.
- Haz que la URL sea
<BASE_HOST>/api/public/webhook/operator. - Añade lo siguiente a Eventos a enviar:
charge.succeeded, charge.updated. - Haz clic en Añadir punto de conexión.
- Usa el secreto del webhook para la variable de entorno
STRIPE_OPERATOR_WEBHOOK_SECRET.
Notificaciones y alertas
| Parámetro | Descripción |
|---|
| MAILER_DSN | Toda la configuración de Symfony Mailer usa un formato de URL tipo DSN. Encontrarás más información en la documentación de Symfony. Por ejemplo, smtp://user:pass@host:port. El valor predeterminado es smtp://null (gestor de correo deshabilitado). |
| TECHNICAL_ALERT_EMAIL | El destinatario de todas las alertas técnicas. Por ejemplo, myemail@example.com. El valor predeterminado está vacío. Es necesario para MAILER_DSN si el gestor de correo está habilitado. |
| TECHNICAL_ALERT_EMAIL_FROM | El remitente de todos los correos electrónicos técnicos. El valor predeterminado está vacío. Es necesario si se ha configurado el gestor de correo. Por ejemplo, noreply@example.com. |
| OPERATOR_NOTIFICATION_URL | El punto de conexión de tu servidor que va a recibir las notificaciones del conector. El valor predeterminado está vacío (notificaciones desactivadas). |
| MAIL_ON_NOTIFICATION_ENDPOINT_DOWN | Enable email alerts if a URL is provided in OPERATOR_NOTIFICATION_URL and that URL is not available or responds with an error. Defaults to true. |
| MAIL_ON_NOTIFICATION_ENDPOINT_DOWN_COOLDOWN | Time between each email alert. Use 0 to disable throttling. The maximum value depends on the notification worker maximum life, that is, 3600 by default. Defaults to 10. |
Véase también