Checkout Generator CLI è uno script in node.js che può generare una lista di checkout da un CSV, integrato perfettamente con le api di FlowPay.

Requisiti necessari per eseguire lo script node

• Node
• Client_id (generato FlowPay)
• Client_secret (generato sempre da FlowPay)
• File CSV da esempio

Usa il package manager npm per installare Checkout Generator CLI.

# clona la repository oppure scarica la zip
git clone https://github.com/FlowPay/checkout-generator.git

# apri la cartella della repo appena scaricata
cd checkout-generator

# installa il pacchetto globale
npm install -g

Se ancora non hai il client di e il client secret, puoi generarli dalla piattaforma di sviluppo dedicata FlowPay.

Puoi impostare le due chiavi come variabile ambiente oppure come parametro script. Per variabile ambiente segui queste istruzioni.

# [facoltativo] imposta le variabili di ambiente clientId e clientSecret

# inserisci il tuo client id al posto di <your_client_id>
export CLIENT_ID=<your_client_id>

# inserisci il tuo client secret al posto di <your_client_secret>
export CLIENT_SECRET=<your_client_secret>

Per windows invece segui queste istruzioni.

È importante sapere che oltre alle chiavi utili per accedere alle api di flowpay è necessario impostare un input path del csv da cui generare il ceckout. Oltre al parametro di input è possibile impostare il path output per scegliere il nome e la directory del csv generato, se si desidera generare nella stessa cartella non importare alcun parametro di output. Vedi gli esempi qui.

È possibile configurare lo script adattandolo alla propria situazione con Mapping o Scripting

# esegui questa istruzione con chiavi impostate nella variabile di ambiente
fpy-generator -p "<your_path_csv>"

# esegui quest istruzione per impostare oltre all'input
# un output path per la generazione del csv finale
fpy-generator -p "<your_path_csv>" -o "<your_path_output_csv>"

# esegui script impostando le chiavi come parametro se non sono come variabile ambiente
fpy-generator -p "<your_path_csv>" -i "<your_client_id>" -s "<your_client_secret>"

Lo script è in grado di accettare alre opzioni per esempio il link di redirect di un checkout. Qui tutte le opzioni che accetta lo script.

È possibile mappare le colonne del proprio csv con due modalità diverse di configurazione:

• File .json
• Opzioni di configurazione da terminale

Di default la configurazione è questa ed è presente nel file map.json

{
	"vat_code": "Partita Iva",
	"amount": "Importo",
	"expire_date": "Data di scadenza",
	"creditor_iban": "Creditore IBAN",
	"remittance": "Causale",
	"code_invoice": "Riferimento checkout",
	"url_checkout": "Link riferimento checkout",
	"recurring_info": "Ricorrenze"
}

Per aggiungere una propria configurazione sarà dunque sufficiente creare un file .json, che abbia uno schema come qui sopra, con i nomi delle proprie colonne relative. Per esempio modifico "Partita Iva" con "Codice Fiscale". In fine, impostare come parametro il path del mio nuovo mapping.

# esegui questa istruzione con chiavi impostate nella variabile di ambiente
fpy-generator -p "<your_path_csv>" ...altri comandi -j "<your_path_map>"

NB. Il valore che modificherai dovrà essere equivalente con il nome della colonna da mappare.

Oppure se si desidera mappare una sola colonna o tutte attravero opzioni di script, segui questa tabella.

Come soluzione custom e diversa dal mapping, è possibile eseguire uno script .mjs con la propria business logic per ogni record del csv, dovrà dunque restituire un oggetto che sarà interpetato dal Checkout Generator CLI. Lo scripting effettuerà l'override del mapping per tutte le poprietà tranne per --urlCheckout, --recurringInfo e --fingerprint.

Lo script dovrà avere la seguente struttura.

export default function (record) {
	/*
		record sarà un oggetto di un array
		con property il nome della colonna corrispondente
	*/

	// ...

	// struttura che checkout si aspetta di ricevere
	return {
		recurring_info,
		creditor_iban,
		vat_code,
		expire_date,
		amount,
		remittance,
	};
}

Esempio di script .msjlo puoi trovare qui

Una volta scritto lo script con la propria logica eseguire Checkout Generator CLI aggingedo il parametro pathScirpt come in questo esempio.

# esegui questa istruzione con chiavi impostate nella variabile di ambiente
fpy-generator -p "<your_path_csv>" ...altri comandi -j "<your_path_script>"