Codex · III

Chiavi API

Le chiavi API ti consentono di chiamare gli endpoint di checkout e stato dal tuo codice, senza il pulsante di acquisto. Ne hai bisogno solo se stai costruendo il tuo checkout o integrazione server; se stai incollando il pulsante di acquisto, puoi saltare completamente questo.

Quando hai bisogno di una chiave

Il pulsante di acquisto funziona senza alcuna chiave — parla con endpoint pubblici e con ambito di progetto. Una chiave è per l'altro percorso: le chiamate che fai dal tuo server, dove crei un checkout o leggi lo stato di una transazione nel codice. Le chiavi vivono nella scheda Chiavi API del tuo progetto.

La scheda Chiavi API. Vuota fino a quando non crei la tua prima chiave.

Crea una chiave

Fai clic su Crea chiave, assegnagli un nome che riconoscerai in seguito — di solito dove viene eseguita, come "Server di produzione" — e fai clic su Genera chiave. Il nome è solo un'etichetta per te; non cambia quello che la chiave può fare (una chiave è limitata a questo progetto).

Denomina la chiave per il luogo in cui vivrà, quindi generala.

Copiarla una volta

La chiave viene mostrata una volta, subito dopo la generazione. Inizia con cmk_. Copiarla adesso e salvala da qualche parte al sicuro — conserviamo solo un hash, quindi non possiamo mostrartela di nuovo. Perderla e semplicemente creane una nuova e elimina la vecchia.

Questo è l'unico momento in cui viene mostrata la chiave completa. Copiarla prima di chiudere.

Tratta la chiave come una password. Usala solo dal codice lato server, inviala nell'intestazione Authorization come token bearer, e non metterla mai in una pagina web, un repository pubblico, o in qualsiasi cosa che viene spedita al browser di un acquirente. Chiunque abbia la chiave può agire per il tuo progetto.

Usa, elenca e revoca

Le chiavi salvate sono elencate per nome, un prefisso mascherato e la data di creazione. Non vedrai mai più la chiave completa — il prefisso è solo sufficiente a distinguerle. L'icona del cestino revoca una chiave immediatamente: qualsiasi codice che la utilizza inizia a essere rifiutato, quindi ruota creando prima la nuova chiave, distribuendola, quindi eliminando la vecchia.

Ogni chiave mostra un prefisso mascherato e una data di creazione; l'icona del cestino la revoca.

Per quello che puoi chiamare con la chiave — creando un checkout dal tuo codice, gestendo gli eventi e votando lo stato — vedi Utilizzo dell'API.

Pronto a collegarlo?

Il piano gratuito copre la maggior parte dei siti e non chiede mai una carta.