Claves API y la API

Una clave API es una contraseña que pertenece a un programa en lugar de a una persona. Trátela de la misma manera: emita una por sistema y reemplácela cuando ese sistema cambie.

Crear una clave

1. Abrir API → Gestión de API y presione Nueva clave.
2. Déle un nombre que indique qué sistema lo utiliza.
3. Elija su Permisos: Acceso completo, o solo las áreas que el sistema necesita. La mayoría de las áreas distinguen entre lectura, creación y modificación.
4. Elija una fecha de caducidad, o ninguna.
5. Usar Mostrar y Copiar en la tarjeta de clave para entregar la clave al sistema que llama. El sistema la envía en el authtoken encabezado.

Cada tarjeta clave muestra los permisos, la fecha de creación, Último uso y una insignia como “activo” o “expira en 5 días”.

Renovar una clave antes de que expire

Catorce días antes de que una clave expire, recibe una notificación en la campana. Presione Renovar en la tarjeta de clave y elija la nueva fecha de vencimiento. IDup crea una nueva clave con los mismos permisos. Cópiela de inmediato, porque esta pantalla aparece solo una vez. La clave antigua sigue siendo válida hasta su propio vencimiento, por lo que puede cambiar el sistema sin interrupciones.

Las áreas a las que puede llegar

La API cubre sus datos de clientes y, dependiendo de su plan, propiedades y alquileres, perfiles de búsqueda, archivos fiscales, archivos de fiduciarios, contabilidad, ejecuciones de nómina y escaneo de recibos. AI Studio y la bandeja de entrada tienen sus propias áreas. La guía de la API solo enumera las áreas que incluye su plan.

La guía de la API

Abrir el Documentación pestaña en la página de gestión de API, o API → Guía de API. Cada área muestra sus campos, ejemplos de solicitudes que puede copiar, respuestas de ejemplo y códigos de error.

Webhooks y otras interfaces

• El Webhooks pestaña envía eventos a su sistema a medida que ocurren — vea Enviar eventos a su propio sistema con webhooks.
• Si la API de Cliente está activada, un Configuración de la API de clientes pestaña abre su configuración, por ejemplo, si los clientes pueden registrarse a través de la API.
• Automatización / flujos de trabajo → Interfaz técnica emite un token para la interfaz GraphQL.
• AI Studio → Claves API personales es un conjunto separado de claves.

Manteniéndolo seguro

1. Una clave por sistema, nunca una compartida.
2. Dé a una clave solo los permisos que el sistema necesita.
3. Establezca una fecha de vencimiento y renueve según un cronograma.
4. Elimine una clave tan pronto como alguien que la conocía se vaya, o el sistema se apague.