Le chiavi API permettono a un altro sistema, come il tuo sito, il gestionale o la cassa, di creare pagamenti su Voucherly a nome della tua attività. Di solito le crei tu e le consegni a chi sviluppa l'integrazione.
Prima di iniziare
- Servono il ruolo Sviluppatore, Amministratore o il proprietario.
- Sandbox e live hanno chiavi diverse. Fai provare l'integrazione con le chiavi di sandbox, e consegna quelle live solo quando funziona.
I tipi di chiave
- Chiave segreta: dà accesso completo all'API. Va solo sul server di chi integra, mai in una pagina web o in un'app.
- Chiave pubblicabile: può stare nelle pagine web. Oggi serve solo al plugin del Marketing, quello che mostra i popup sul tuo sito, e non permette di creare pagamenti. La trovi già pronta nell'elenco, e le sue richieste non compaiono nei log.
- Chiave con limitazioni: un tipo di chiave che non si crea più. Se ne vedi una nell'elenco, chiedi a chi integra di passare alla chiave segreta.
Generare la chiave segreta
- Apri Chiavi API.
- Controlla con l'interruttore Sandbox in alto in quale ambiente sei.
- Genera la chiave segreta con Genera chiave.
- Copiala subito e consegnala in modo sicuro, per esempio con un gestore di password condiviso. In live la chiave segreta si vede una sola volta: poi non si recupera più.
Dal menu della chiave, con Modifica chiave, puoi darle un nome che ricordi dove la usi, per esempio «Backend produzione».
Se hai perso la chiave o temi che sia stata vista
- Dal menu della chiave, scegli Ruota chiave.
- In La chiave attuale scade, scegli quanto tempo lasciare a chi integra per sostituirla: da immediatamente a tra 7 giorni. Se pensi che qualcuno l'abbia vista, scegli immediatamente.
- Conferma e consegna la chiave nuova.
Per chi sviluppa
Come si usano le chiavi, gli esempi e il riferimento completo dell'API sono nella documentazione per sviluppatori.