Restringir una clave de API (Acceso a la API)
Cada canal de venta tiene su propia clave de API. Con el bloque Acceso a la API usted elige qué partes de la API de QrX puede usar esa clave, por ejemplo cuando un socio o un sistema externo solo debe leer el stock.
Dónde encontrarlo
Vaya a Settings > Business > Merchant Channels, abra el canal de venta y elija la pestaña Settings. El bloque Acceso a la API está debajo de la clave de API. Necesita el permiso Gestionar canales para cambiarlo; los demás usuarios solo pueden verlo.
Acceso completo y restringido
Acceso completo: la clave puede usar todas las partes de la API de QrX, también las que QrX añada más adelante. Todas las claves empiezan así. La excepción es el CRM: una llamada al CRM solo se acepta si la parte CRM está marcada, así que para usar la API del CRM restrinja la clave y márquela (véase abajo).
Restringido: la clave solo funciona para las partes que usted ha marcado. Una llamada a otra parte se rechaza con un error 403.
Las partes que puede marcar
Devoluciones: Leer devoluciones (
returns.read), Crear y modificar devoluciones (returns.write), Registrar devoluciones recibidas (returns.receiving.write), Decidir cómo se resuelve una devolución (returns.resolutions.write), Enviar mensajes en una devolución (returns.messages.write), Gestionar webhooks de devoluciones (returns.webhooks.manage).Entradas: Leer entregas entrantes y recepciones (
inbound.read), Anunciar, recibir y modificar entregas entrantes y recepciones (inbound.write).Stock: Leer niveles de stock, artículos, ubicaciones, movimientos, recuentos y contenedores (
stock.read), Ajustar stock y crear o modificar artículos y ubicaciones (stock.write).Compras: Leer pedidos de compra y sus precios (
purchasing.read), Crear, enviar y cerrar pedidos de compra (purchasing.write).Preparación: Leer listas de preparación (
fulfilment.read).Tareas: Leer tareas de equipo (
tasks.read).CRM: Leer personas, empresas, negocios y embudos del CRM (
crm.read), Crear y modificar personas, empresas, negocios y notas del CRM (crm.write). Los endpoints del CRM de tareas y actividades usan la parte de lectura.
La restricción cubre estas partes de la API de devoluciones, entradas, stock y CRM. Crear transacciones, etiquetas y productos con la clave no está en la lista y sigue funcionando.
Restringir una clave
Active Restringir esta clave.
Marque las partes que la clave puede usar. Marque al menos una.
Haga clic en Guardar acceso a la API. El bloque se guarda por separado.
QrX pregunta ¿Restringir esta clave API? y muestra en Deja de funcionar lo que la clave ya no puede hacer. Revise la lista y haga clic en Restringir la clave.
Atención: cada parte que no esté marcada deja de funcionar al instante, también para las integraciones que funcionan hoy. Una integración de devoluciones o de entradas que usaba esta clave sin restricción recibe un error en cuanto su parte no esté marcada. Las partes que QrX añada más adelante están desactivadas para una clave restringida hasta que usted las marque.
El retraso de 30 segundos
Un cambio puede tardar hasta 30 segundos en aplicarse. Durante ese tiempo, una llamada todavía puede aceptarse o rechazarse según el ajuste anterior. Espere medio minuto antes de probar.
Volver al acceso completo
Desactive Restringir esta clave y haga clic en Guardar acceso a la API. La clave vuelve a mostrar Acceso completo.
Preguntas frecuentes
Mi integración recibe de repente un error 403. ¿Qué ha pasado?
Alguien ha restringido la clave y la parte que usa su integración no está marcada. Para el stock, el código de error es STOCK_SCOPE_MISSING. Marque la parte, guarde y espere 30 segundos.
Una llamada al CRM recibe un error 403 con el código CRM_SCOPE_MISSING. ¿Qué hago?
La parte CRM no está marcada en la clave. Active Restringir esta clave, marque CRM (lectura, escritura o ambas), guarde y espere 30 segundos. Véase "API pública del CRM".
¿Restringir cambia la clave en sí?
No. La clave y sus tokens de acceso siguen siendo los mismos; solo cambia lo que la clave puede hacer. Para sustituir la clave en sí, use Regenerate API Key. Consulte "Webhooks y claves de API en PortalX".
Cuándo contactar con nuestro equipo de soporte
Contacte con el soporte de QrX cuando una parte marcada siga rechazándose más de un minuto después de guardar. Indique el canal de venta, el endpoint y la hora, nunca la clave ni el token.