Chiavi API

Gestione delle chiavi API in ProcessMind

Per integrare l’API di ProcessMind, è necessario creare e gestire chiavi API. Scopra come generarle, utilizzarle e proteggerle.

Nelle impostazioni dell’account ProcessMind, apra la sezione «Chiavi API». Qui può creare una nuova chiave API selezionando il pulsante Nuova chiave API dell’ambiente. Assegni un nome alla chiave per poterla identificare in seguito.

Creare una chiave API

Può creare più chiavi API per applicazioni o servizi diversi. Ogni chiave può essere gestita separatamente: se necessario, può revocarla senza influire sulle altre integrazioni. Dopo aver generato la chiave, la copi e la conservi in un luogo sicuro. Per motivi di sicurezza, viene visualizzata una sola volta durante la creazione.

Chiavi API dell’organizzazione

Gli amministratori dell’organizzazione possono creare anche chiavi API dell’organizzazione nella stessa pagina. A differenza delle chiavi dell’ambiente, una chiave dell’organizzazione funziona in tutti gli ambienti (tenant) dell’organizzazione, consentendo a una singola integrazione di servirli tutti. Utilizzi le chiavi dell’organizzazione per:

• Creare chiavi API per gli ambienti: creare, aggiornare ed eliminare chiavi con ambito limitato al tenant tramite l’API esterna (/v1/tenant/{tenantId}/api-keys).
• Generare link di accesso monouso: indirizzare un utente dal proprio prodotto direttamente a ProcessMind, già autenticato (/v1/tenant/{tenantId}/users/{userId}/login-token).

Ambiti

Abiliti sessions solo per le chiavi che devono consentire il passaggio all’accesso e le tratti come password: il token generato consente all’utente di accedere senza inserire la password. Una chiave dell’organizzazione può generare token per gli utenti di tutti gli ambienti dell’organizzazione; una chiave dell’ambiente può farlo solo per gli utenti del proprio ambiente.

Passaggio monouso all’accesso

POST /v1/tenant/{tenantId}/users/{userId}/login-tokenRestituisce un token monouso, valido per 60 secondi e associato all’utente, all’ambiente e all’organizzazione, insieme a un url. Indirizzi il browser dell’utente a quell’URL: accederà a ProcessMind con una sessione personale, senza link inviati via e-mail né impersonificazione. Facoltativamente, includa un path nel corpo della richiesta per indirizzare l’utente a una pagina specifica. La chiave deve avere l’ambito sessions e il token può essere generato per un utente solo se il tenant a cui appartiene rientra tra quelli serviti dalla chiave.

La generazione dei token viene registrata negli audit, è soggetta a limiti di frequenza rigorosi e viene bloccata immediatamente se la chiave viene disabilitata o l’utente perde l’accesso. Il token viene restituito una sola volta e non viene mai registrato nei log.

Argomenti correlati

• Panoramica dell’API: come effettuare chiamate API.
• Documentazione di riferimento dell’API: documentazione degli endpoint.