Documentación
La API de Dotwick
REST sobre JSON. Crea un código, cambia adónde lleva y recibe un webhook firmado cuando alguien lo escanee. La referencia de abajo se genera a partir de los mismos contratos con los que valida la API. No hace falta ningún SDK: cada ejemplo es curl, JavaScript o Python.
Primeros pasos
Primeros pasosInicio rápidoTres pasos: crea una clave en la app, crea un código y escanea el enlace corto que devuelve.Primeros pasosAutenticaciónEnvía tu clave secreta como token bearer. Las claves llevan scopes y actúan con el rol de quien las creó en un espacio de trabajo, con un tope de Editor.Primeros pasosErroresLos errores son JSON con un código estable sobre el que ramificar, un mensaje legible y un id de solicitud para soporte.
Códigos
Códigos / Crear un códigoCrear un códigoCrea un código y lo devuelve con su enlace corto. El destino de un código dinámico se puede cambiar después con PATCH sin tocar el código impreso.Códigos / Listar códigosListar códigosLista los códigos que la clave puede ver, los más nuevos primero, una página cada vez. Filtra por carpeta, tipo, estado o un término de búsqueda.Códigos / Actualizar un códigoActualizar un códigoCambia el destino, nombre, diseño, reglas, carpeta o estado de un código. El enlace corto y cada copia impresa siguen funcionando: solo cambia adónde apunta.Códigos / Creación en loteCreación en loteCrea hasta 500 códigos de un mismo tipo en una sola solicitud, como una tanda en segundo plano que puedes seguir: las mismas tandas que una subida de CSV en la app.
Estadísticas
Webhooks
Webhooks / Registrar un endpointRegistrar un endpointRegistra un endpoint https y elige los eventos. Enviamos cada evento con POST como JSON firmado y reintentamos hasta que responda 2xx.Webhooks / Tipos de eventoTipos de eventoTodos los eventos comparten un mismo envoltorio. data lleva los mismos objetos que devuelve la API, así que un solo analizador sirve para ambos.Webhooks / Verificar firmasVerificar firmasLas entregas se firman según la especificación Standard Webhooks. Comprueba la firma antes de fiarte de una carga útil.
Conversiones
ConversionesPíxel de conversiónCuenta las visitas y pedidos tras un escaneo. Un script en tu web guarda el identificador de clic e informa del objetivo, con consentimiento y sin datos personales.ConversionesEnvío desde el servidorInforma de una conversión desde tu servidor cuando se confirma el pedido o el píxel no llegó a cargar. Envías el identificador de clic, el evento y un valor opcional.
Integraciones
IntegracionesZapierEnvía escaneos, respuestas de formularios y códigos nuevos a las apps de Zapier, y crea o cambia códigos desde un Zap. La app de Dotwick para Zapier usa una clave de API.IntegracionesMakeLanza escenarios de Make con escaneos, formularios y códigos nuevos, y crea o cambia códigos desde un escenario. La app de Dotwick para Make usa una clave de API.IntegracionesShopifyMira los ingresos que cada código QR aporta a tu tienda Shopify. La app lee totales de pedidos y el identificador de clic, nunca al cliente. Ficha en camino.IntegracionesSlackEnvía alertas de escaneo y un resumen semanal a un canal de Slack, y crea o consulta códigos con /dotwick. La ficha de Slack llegará pronto.IntegracionesHubSpot y SalesforceCrea contactos en HubSpot y leads en Salesforce a partir de formularios y tarjetas de visita, y mira los escaneos de un código en la cronología. Fichas próximamente.
Tarjetas de visita
Apps
AppsApp móvilGestiona tus códigos desde el móvil: escanea, crea, consulta escaneos y muestra tu propia tarjeta de visita. Las apps de iOS y Android llegarán pronto.AppsExtensión de ChromeCrea un código QR de la página en la que estás, desde tu navegador. La extensión llegará pronto a la Chrome Web Store.
Asistentes de IA
Referencia
ReferenciaReferencia de la APICada ruta que puede llamar una clave de API y su scope. URL base https://api.dotwick.com, documento OpenAPI en https://api.dotwick.com/openapi.json.ReferenciaLímites de solicitudesLos límites son por espacio de trabajo, compartidos por todas las claves de API que contiene, y escalan con el plan.ReferenciaPaginaciónLas listas se paginan con cursor: { data, nextCursor }, de más nuevo a más antiguo salvo que un orden indique otra cosa.ReferenciaIdempotenciaEnvía una Idempotency-Key con un POST y reintentarlo nunca puede hacer el trabajo dos veces.ReferenciaVersionadoUna sola versión, v1, bajo /v1. Solo crece: nada de lo que contiene cambia ni desaparece sin un año de aviso.ReferenciaRegistro de cambiosCada adición y cada obsolescencia de la API, de más nueva a más antigua. Las cabeceras de obsolescencia enlazan aquí.