Chiavi API e l'API

Una chiave API è una password che appartiene a un programma anziché a una persona. Trattatela allo stesso modo: emetta una per sistema e sostituiscala quando quel sistema cambia.

Creare una chiave

1. Apri API → Gestione API e premere Nuova chiave.
2. Assegni un nome che indichi quale sistema lo utilizza.
3. Scelga il suo Permessi: Accesso completo, o solo le aree di cui il sistema ha bisogno. La maggior parte delle aree distingue tra lettura, creazione e modifica.
4. Scelga una data di scadenza, o nessuna.
5. Usare Mostra e Copia sulla scheda chiave per consegnare la chiave al sistema chiamante. Il sistema la invia nel authtoken intestazione.

Ogni carta chiave mostra i permessi, la data di creazione, Ultimo utilizzo e un badge come “attivo” o “scade tra 5 giorni”.

Rinnovare una chiave prima che scada

Quattordici giorni prima della scadenza di una chiave, riceve una notifica nel campanello. Premere Rinnovare sulla scheda chiave e scegliere la nuova data di scadenza. IDup crea una nuova chiave con gli stessi permessi. Copiarla immediatamente, poiché questa visualizzazione appare solo una volta. La vecchia chiave rimane valida fino alla sua scadenza, quindi può passare il sistema senza interruzioni.

Le aree a cui può accedere

L'API copre i dati dei Suoi clienti e, a seconda del Suo piano, proprietà e affitti, profili di ricerca, file fiscali, file fiduciari, contabilità, esecuzioni di buste paga e scansione delle ricevute. AI Studio e la casella di posta hanno le loro aree. La guida API elenca solo le aree incluse nel Suo piano.

La guida API

Apri il Documentazione scheda nella pagina di gestione API, oppure API → Guida API. Ogni area mostra i suoi campi, esempi di richieste che può copiare, risposte di esempio e codici di errore.

Webhooks e altre interfacce

• Il Webhooks scheda invia eventi al suo sistema man mano che si verificano — veda Invii eventi al suo sistema con webhooks.
• Se l'API Cliente è attivata, un Impostazioni API clienti scheda apre le sue impostazioni, ad esempio se i clienti possono registrarsi tramite l'API.
• Automazione / flussi di lavoro → Interfaccia tecnica emette un token per l'interfaccia GraphQL.
• AI Studio → API personali è un insieme separato di chiavi.

Mantenerlo sicuro

1. Una chiave per sistema, mai una condivisa.
2. Dia a una chiave solo le autorizzazioni di cui il sistema ha bisogno.
3. Imposti una data di scadenza e rinnovi secondo un programma.
4. Elimini una chiave non appena qualcuno che la conosce lascia, o il sistema viene spento.