Creare e gestire chiavi API
Creare una chiave per l'API pubblica, sceglierne gli ambiti e la scadenza, limitarla per indirizzo IP, poi revocarla.
Una chiave API permette ai vostri strumenti di chiamare l’API pubblica di Upsellr per conto della vostra organizzazione. L’accesso all’API è riservato all’offerta Enterprise.
Dove trovare le chiavi
Aprite il menu dell’account, poi Manage e API & webhooks. Con un’offerta diversa da Enterprise, la sezione mostra «Included in the Enterprise plan» e un pulsante per cambiare offerta.
Creare una chiave
- Cliccate su Create API Key.
- Datele un Name che dica a cosa serve, per esempio il nome dello strumento che la usa.
- Scegliete uno Scope preset:
- Read only: leggere i canali, i prodotti, le fonti, i workflow, i membri e l’organizzazione.
- Read & Write: tutto, tranne avviare workflow.
- Full access: tutti gli ambiti, compreso l’avvio di workflow.
- Custom: spuntate uno per uno gli ambiti desiderati.
- Scegliete l’Expiration: 7 giorni, 30 giorni, 90 giorni, 1 anno, 3 anni, No expiration, oppure una durata personalizzata da 1 a 1.095 giorni.
- Se serve, compilate Allowed IPs e Allowed User-Agents, separati da virgole.
- Cliccate su Create Key.
La chiave viene mostrata una sola volta. Copiatela e conservatela in un luogo sicuro prima di chiudere la finestra.
Gli ambiti disponibili
| Risorsa | Ambiti |
|---|---|
| Canali | Creare, leggere, modificare, eliminare |
| Prodotti | Creare, leggere, modificare, eliminare |
| Fonti | Leggere, caricare file sorgente |
| Workflow | Leggere, avviare |
| Organizzazione | Leggere l’organizzazione, leggere i membri |
Revocare una chiave
Nell’elenco, cliccate su Revoke accanto alla chiave. Ogni integrazione che la usa smette di funzionare immediatamente. Questa azione è irreversibile.
Buono a sapersi
- Solo i proprietari e gli amministratori creano e revocano le chiavi. I membri le vedono in sola lettura.
- L’elenco mostra per ogni chiave i suoi ambiti, la sua data di scadenza e il suo Last used: una chiave mai usata è spesso una chiave da revocare.
- Avviare un workflow può coinvolgere molti prodotti e crediti. Date l’ambito di avvio solo alle integrazioni che ne hanno bisogno.
- Create una chiave per integrazione, con i soli ambiti necessari.
- Una chiave persa non può essere mostrata di nuovo: revocatela e createne una nuova.