Claus d'API i l'API

Una clau API és una contrasenya que pertany a un programa en lloc d'una persona. Tracti-la de la mateixa manera: emeti una per sistema i substitueixi-la quan aquest sistema canviï.

Crear una clau

1. Obrir API → Gestió d'API i premi Nova clau.
2. Donar-li un nom que indiqui quin sistema l'utilitza.
3. Trieu el seu Permisos: Accés complet, o només les àrees que el sistema necessita. La majoria d'àrees distingeixen entre lectura, creació i modificació.
4. Triï una data de caducitat, o cap.
5. Utilitzi Mostrar i Copiar en la targeta clau per lliurar la clau al sistema que truca. El sistema l'envia en el authtoken capçalera.

Cada targeta clau mostra els permisos, la data de creació, Últim ús i una insígnia com ara «actiu» o «caduca en 5 dies».

Renovar una clau abans que caduqui

Catorze dies abans que una clau caduqui, rebrà una notificació a la campana. Premi Renovar en la targeta clau i trieu la nova data de caducitat. IDup crea una nova clau amb els mateixos permisos. Copieu-la immediatament, perquè aquesta pantalla només apareix una vegada. L'antiga clau continua sent vàlida fins a la seva pròpia caducitat, de manera que podeu canviar el sistema sense interrupcions.

Les àrees a les quals pot arribar

L'API cobreix les seves dades de clients i, depenent del seu pla, propietats i lloguers, perfils de cerca, arxius fiscals, arxius de fiduciari, comptabilitat, execucions de nòmines i escaneig de rebuts. AI Studio i la bústia tenen les seves pròpies àrees. La guia de l'API només llista les àrees que inclou el seu pla.

La guia de l'API

Obri el Documentació pestanya a la pàgina de gestió de l'API, o API → Guia de l'API. Cada àrea mostra els seus camps, exemples de sol·licituds que pot copiar, respostes d'exemple i codis d'error.

Webhooks i altres interfícies

• El Webhooks pestanya envia esdeveniments al seu sistema a mesura que succeeixen — vegeu Enviï esdeveniments al seu propi sistema amb webhooks.
• Si l'API de Clients està activada, un Configuració de l'API de clients pestanya obre la seva configuració, per exemple, si els clients poden registrar-se a través de l'API.
• Automatització / fluxos de treball → Interfície tècnica emet un token per a la interfície GraphQL.
• AI Studio → Claus API personals és un conjunt separat de claus.

Conservant-ho segur

1. Una clau per sistema, mai una compartida.
2. Donar a una clau només els permisos que el sistema necessita.
3. Configuri una data de caducitat i renovi segons un calendari.
4. Elimini una clau tan aviat com algú que la coneixia marxi, o el sistema s'apagui.