Una chiave API permette al suo software di comunicare con la sua piattaforma tramite la REST API, per esempio per leggere i membri, iscrivere qualcuno a un corso o collegare un sito WordPress. Ogni chiave è una password segreta per un programma, quindi decide lei per ogni chiave cosa può fare, e può sostituirla o eliminarla in qualsiasi momento.
Chi può gestire le chiavi API
API si trova nel blocco Integrazioni e API del menu delle impostazioni. Il suo ruolo ha bisogno di Gestisci chiavi API oltre a Aggiorna impostazioni della piattaforma. Questo permesso non è mai disponibile per un ruolo personalizzato, quindi solo i ruoli predefiniti Proprietario e Amministratore possono lavorare qui. Lo stesso permesso apre anche App OAuth e Accesso unico.
L'accesso all'API dipende dal suo piano. Se il suo piano non lo include, la pagina mostra «L'accesso all'API è incluso in ogni piano a pagamento. Cambi piano per creare chiavi API.» insieme a Cambia piano, e Nuova chiave API resta disattivato. Le chiavi che esistono già vengono rifiutate dall'API finché il piano non lo include di nuovo.
Creare una chiave
Clicchi su Nuova chiave API. Si apre la finestra Crea chiave API.
- Inserisca un Nome della chiave che le dica in seguito chi usa la chiave, per esempio lo strumento o il sito web a cui appartiene. Il nome è obbligatorio.
- Decida cosa può fare la chiave. Una nuova chiave parte con accesso completo, quindi ogni permesso è selezionato.
- Clicchi su Crea.
Per limitare la chiave, clicchi su Limita a permessi specifici. Tutti i permessi vengono deselezionati e lei sceglie quelli che le servono. I permessi sono raggruppati per area, come Membri, Gruppi, Corsi o Pagamenti, e ogni area elenca azioni come Visualizza o Gestisci con una breve descrizione. Seleziona tutto e Deseleziona tutto cambiano un'intera area in una volta. Un contatore mostra quanti permessi ha la chiave. Una chiave ha bisogno di almeno un permesso, e Ripristina l'accesso completo li seleziona di nuovo tutti.
Dopo aver cliccato su Crea, la finestra La tua nuova chiave API mostra la chiave completa una sola volta. La copi e la conservi in un posto sicuro. In seguito l'elenco mostra solo gli ultimi quattro caratteri, e nessuno può più visualizzare la chiave completa.
Usare una chiave
Il riquadro Documentazione API sopra l'elenco mostra l'URL di base dell'API con un pulsante per copiarlo, e Apri documentazione porta al riferimento interattivo con tutti gli endpoint.
Invii la chiave con ogni richiesta, come Bearer token nell'header
Authorization oppure nell'header X-Api-Key. Le chiavi iniziano con mak_.
Una richiesta che richiede un permesso che la chiave non ha viene rifiutata.
Una chiave è legata al membro del team che l'ha creata. Se quella persona non fa più parte della sua area di lavoro, la chiave smette di funzionare, quindi crei le chiavi per collegamenti di lunga durata con un account che resta.
L'elenco mostra ogni chiave con Nome, Chiave, Ultimo utilizzo e Creato. Ultimo utilizzo viene aggiornato al massimo una volta al minuto, il che basta per capire se una chiave è ancora in uso.
Modificare, ruotare ed eliminare una chiave
Clicchi su una chiave nell'elenco, oppure usi Modifica, l'icona della matita nella sua riga, per cambiarne il nome o i permessi. Le modifiche hanno effetto con Salva.
Se una chiave potrebbe essere trapelata, la ruoti. Ruota chiave nella stessa finestra chiede: «Ruotare questa chiave? Il vecchio secret smetterà immediatamente di funzionare e le integrazioni esterne avranno bisogno di quello nuovo.» Dopo la conferma, la nuova chiave compare una sola volta in La tua nuova chiave API. Nome e permessi restano invariati, e Ultimo utilizzo riparte da zero. Inserisca la nuova chiave in ogni strumento che usava quella vecchia.
Per rimuovere una chiave, usi Elimina, l'icona del cestino nella sua riga, oppure Elimina nella finestra aperta, e confermi. Da quel momento ogni strumento che la usa ancora viene rifiutato.
App OAuth, Accesso unico e webhook
Incollare una chiave non è l'unico modo per collegarsi:
- App OAuth permettono ad altre MemberArea di collegare il suo software con OAuth invece che con una chiave API incollata.
- Accesso unico fa accedere i membri da un altro sistema. È descritto in Accesso, registrazione e SSO.
- I webhook per gli eventi dei membri e dei pagamenti hanno una pagina propria in Impostazioni > Webhook, che compare non appena i Pagamenti sono attivi.