"Console API" è accessibile sia sulla tua interfaccia di test che quella di produzione ai seguenti URL :
- Stage : https://stage-console.hipay.
com/api/docs - Produzione : https://console.hipay.com/
api/docs
Per iniziare, genera un export ricorrente tramite la Console HiPay.
Pensa a :
|
Generazione di chiavi temporanee
In primis, genera un token (specie di chiave temporanea) di accesso per identificarti usando il seguente link :
- Stage : https://stage-console.hipay.
com/api/docs - Produzione : https://console.hipay.com/
api/docs
- Clicca sul punto finale POST/api/login
- Clicca sul pulsante "Provalo" (Try it out)
- Clicca su ESEMPIO DI VALORE | MODELLO e modifica i termini :
- Nel campo "username" : "string", inserisci la tua email di connessione alla Console tra le virgolette al posto di "string".
- Nel campo "password" : "string", inserisci la tua password tra le virgolette al posto di "string" (attenzione : la tua password sarà visibile, assicurati di essere da solo al momento dell'inserimento).
- Clicca il pulsante "Esegui".
- Il tuo token è generato. E' disponibile nella zona su fondo nero "Response body".
- Seleziona questo token selezionando le linee tra le virgolette.
- Copia il token (ctrl+C su PC o Cmd + C su Mac).
Esempio :
{ "token": "[IL TUO TOKEN]" }
Recupero dei file di esportazione ricorrenti via API
Adesso che il tuo token è salvato sul tuo PC, accedi all'URL https://console.hipay.com/
- Clicca sul pulsante "Autorizza".
- Inserisci il tuo token nel campo "Valore" (ctrl+V su PC o Cmd + V su Mac) facendolo precedere da uno spazio.
- Clicca su "Autorizza".
- La finestra "Autorizzazione disponibile" conferma il tuo accesso.
- Chiudi la finestra cliccando sulla "x" in alto a destra
GET / api/ exports ti permette di elencare gli export ricorrenti.
- Clicca su "Provalo" per recuperare la lista.
- Clicca su "Esegui"
- Una tabella Json appare nella parte Response Body.
Esempio :
[ { "exportId": 139, "dateCreated": "2019-11-20T09:45:10+01:00", "exportFiles": [
{
"fileId": 227,
"dateCreated": "2020-01-16T01:00:02+01:00",
"filename": "TOUS_LES_COMPTES_20200116-010002",
"hash": "0e5c31c4c5b1a0d93f4fa2c04a098526609b58782831b986864ecfffe11cd4be710e701b25463faad33c908567b36d752c39e369692405b7e641cde7ffe4d003",
"status": "sent",
"nbItems": 244
}, ], "filePrefix": "TOUS_LES_COMPTES", "emails": "[TUA EMAIL]", "module": "transaction", "columns": "{\"merchant_order_id\":\"ID commande\",\"sentinel_result\":\"Statut sentinel\",\"card_country\":\"Pays de la carte\",\"sentinel_score\":\"Score\",\"auth\":\"Statut auth\",\"auth_method\":\"Méthode authentification\",\"payment_means\":\"Moyen paiement\",\"amount\":\"Montant autorisé\",\"trxid\":\"ID transaction\",\"status\":\"Statut actuel de la transaction\",\"balance\":\"Solde restant\",\"order_currency\":\"Devise\",\"custom_data\":\"Données personnalisées\",\"tpe_reference\":\"TPE réf.\",\"operation_date\":\"Opération\",\"operation_amount\":\"Mnt opération paiement\",\"operation_status\":\"Statut opération paiement\"}", "filters": "{\"size\":\"-1\",\"order_by\":\"created_date\",\"direction\":\"desc\",\"card_country\":\"FR\",\"authorized_by_payment_means_date_to\":\"2020-01-31\",\"authorized_by_payment_means_date_interval\":\"cd\",\"authorized_by_payment_means_date_from\":\"2020-01-31\"}", "urlFilters": "?fp_authorized_by_payment_means_date_from=2019-11-20&fp_authorized_by_payment_means_date_interval=cd&fp_authorized_by_payment_means_date_to=2019-11-20&fp_card_country=FR", "separator": "comma", "recurrence": "daily", "receiveByEmail": true,
"recurrenceDay": null,
"nbOccurrence": 10,
"endRecurrenceDay": null,
"userId": 123,
"config": null } ]
- Il campo "exportId" dà il riferimento unico delle vostre esportazioni.
- Il campo "exportFiles" permette di conoscere la referenza di uno o più file di esportazione già generati.
Per recuperare il file, bisogna innanzitutto recuperare l'hash di sicurezza criptato utilizzando il punto finale GET/api/exports/[ID dell'export]/files.
- Clicca su "Provalo"
- Compila il campo Export ID : (per l'esempio) 139
- Clicca sul pulsante "Esegui"
- Una tabella Json appare nella parte Response Body.
Esempio:
[ { "fileId": 227, "dateCreated": "2020-01-16T01:00:02+01:00", "filename": "TOUS_LES_COMPTES_20200116-010002", "hash": "0e5c31c4c5b1a0d93f4fa2c04a098526609b58782831b986864ecfffe11cd4be710e701b25463faad33c908567b36d752c39e369692405b7e641cde7ffe4d003"
"status": "active",
"nbItems": 123, }
]
- Il campo "fieId" dà il riferimento unico dei tuoi file.
- Il campo "hash" permette di scaricare il file.
Per scaricare il file, utilizza l'endpoint GET/api/export-files/[ID del file]
- Clicca su "Provalo"
- Compila il campo Export file ID : (per l'esempio) 227
- Compila il campo Export file secured hash : (per l'esempio) 0e5c31c4c5b1a0d93f4fa2c04a098526609b58782831b986864ecfffe11cd4be710e701b25463faad33c908567b36d752c39e369692405b7e641cde7ffe4d003
- Clicca sul pulsante "Esegui"
Attenzione : il file non è possibile scaricarlo, ma otterrai un esempio cURL che ti permette di scaricare il file sulla mail di lavoro grazie al tuo terminale.
cURL -X GET "https://console.hipay.com/api/export-files/227?hash=0e5c31c4c5b1a0d93f4fa2c04a098526609b58782831b986864ecfffe11cd4be710e701b25463faad33c908567b36d752c39e369692405b7e641cde7ffe4d003" -H "accept: application/zip" -H "X-Authorization: Bearer [MON TOKEN]" --output [DOSSIER DE DESTINATION]
NOTA BENE I file sono disponibili per il download:
|
Personalizza il tuo export
Per personalizzare certi dati dei tuoi export utilizza l'endpoint PUT/api/exports/[ID dell'export]
{ "filePrefix": "TOUS_LES_COMPTES", "columns": "{\"merchant_order_id\":\"ID commande\",\"sentinel_result\":\"Statut sentinel\",\"card_country\":\"Pays de la carte\",\"sentinel_score\":\"Score\",\"auth\":\"Statut auth\",\"auth_method\":\"Méthode authentification\",\"payment_means\":\"Moyen paiement\",\"amount\":\"Montant autorisé\",\"trxid\":\"ID transaction\",\"status\":\"Statut actuel de la transaction\",\"balance\":\"Solde restant\",\"order_currency\":\"Devise\",\"custom_data\":\"Données personnalisées\",\"tpe_reference\":\"TPE réf.\",\"operation_date\":\"Opération\",\"operation_amount\":\"Mnt opération paiement\",\"operation_status\":\"Statut opération paiement\"}", "separator": "comma", "recurrence": "daily", "receiveByEmail": true }
I campi personalizzabili sono :
- Il nome del file "filePrefix"
- I nomi delle colonne "columns". Questo campo è un campo Json, solo il valore è libero.
- Esempio : per "merchant_order_id\":\"ID commande\" puoi modificare il nome della colonna in questo modo "merchant_order_id\":\"ORDER\"
NOTA BENE Per impostazione predefinita, i titoli delle colonne (campi "colonne") sono nella lingua di preferenza della tua interfaccia della Console. |
- Il separatore "separatore". I possibili valori sono :
- virgola
- punto e virgola
- La frequenza dell'export "ricorrente". I possibili valori sono :
- una sola volta
- giornalmente
- settimanalmente
- mensilmente
- ogni mese alla data odierna
- annualmente
- La ricezione sull'email. I possibili valori sono :
- vero : riceverai l'export via email
- falso : non riceverai l'email
- La configurazione : "config" è un oggetto (JSON) che ti permette di modificare il formato dei tuoi export. I possibili valori sono :
- granularità: "transazione" o "operazione" per una visualizzazione per transazione o per operazione di pagamento. Di default, se questa opzione non è specificata, la visualizzazione dell'export viene fatta per transazione (SOLO export dal modulo delle transazioni).
Articoli associati :
Commenti
0 commenti
Questo articolo è chiuso ai commenti.