Export automatique via l’API Console – Centre de support HiPay

« Console API » est accessible aussi bien sur votre interface de test (stage) que sur celle de production via les URL suivantes.

Stage : https://stage-console.hipay. com/api/docs
Production : https://console.hipay.com/api/docs

Pour commencer, générez un export récurrent via HiPay Console.

Pensez à :

choisir vos colonnes,
définir l’ordre de ces colonnes,
utiliser des filtres (assurez-vous, par exemple, d’avoir un filtre de date prédéfinie comme "Hier"),
faire un tri sur une colonne (ou conserver le tri par défaut).

Génération d’une clé temporaire

Première étape, générez un token (sorte de clé temporaire) d’accès pour vous identifier en utilisant les URL suivantes.

Stage : https://stage-console.hipay. com/api/docs
Production : https://console.hipay.com/api/docs

Cliquez sur le endpoint POST /api/login.
Cliquez sur le bouton "Try it out" (Essayez-le).
Cliquez dans la zone EXAMPLE VALUE | MODEL et modifiez les termes :
- Dans le champ "username" : "string", renseignez votre adresse e-mail de connexion à HiPay Console entre guillemets à la place de "string".
- Dans le champ "password" : "string", renseignez votre mot de passe entre guillemets à la place de "string" (attention : votre mot de passe sera visible, assurez-vous d’être seul pour le renseigner).
- Cliquez sur le bouton "Execute".
- Votre token est généré. Il est disponible dans la zone sur fond noir "Response body".
  - Sélectionnez ce token en sélectionnant les lignes entre guillemets.
  - Copiez le token (Ctrl+C sur PC ou Cmd+C sur Mac).

Exemple :

{ "token": "[VOTRE TOKEN]" }

Récupération des fichiers d’export récurrent via l’API

Maintenant que votre token est en mémoire sur votre ordinateur, accédez à l’URL https://console.hipay.com/ api/docs.

Cliquez sur le bouton "Authorize".
Entrez votre token dans le champ "Value" (Ctrl+V sur PC ou Cmd+V sur Mac) en le précédant de Bearer [espace].
Cliquez sur "Authorize".
- La fenêtre "Available authorizations" confirme votre accès.
- Fermez la fenêtre en cliquant sur la croix en haut à droite.

GET / api/exports vous permet de lister les exports récurrents.

Cliquez sur "Try it out" pour récupérer la liste.
Cliquez sur "Execute".
Un tableau JSON apparaît dans la partie "Response Body".

Exemple :

[
  {
    "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": "[VOTRE 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
  }
]

Le champ "exportId" donne la référence unique de vos exports.
Le champ "exportFiles" permet de connaître la référence d’un ou de plusieurs fichiers d’export déjà générés.

Pour récupérer le fichier, il faut d’abord récupérer le hash de sécurité encrypté en utilisant le endpoint GET/api/exports/[ID de l’export]/files.

Cliquez sur "Try it out".
Remplissez le champ Export ID : (pour l’exemple) 139.
Cliquez sur le bouton "Execute".
Un tableau JSON apparaît dans la partie "Response Body".

Exemple :

[
  {
    "fileId": 227,
    "dateCreated": "2020-01-16T01:00:02+01:00",
    "filename": "TOUS_LES_COMPTES_20200116-010002",
    "hash": "0e5c31c4c5b1a0d93f4fa2c04a098526609b58782831b986864ecfffe11cd4be710e701b25463faad33c908567b36d752c39e369692405b7e641cde7ffe4d003"
    "status": "active",
    "nbItems": 123,
  }
]

Le champ "fileId" donne la référence unique de vos fichiers.
Le champ "hash" permet de télécharger le fichier.

Pour télécharger le fichier, utilisez le endpoint GET/api/export-files/[ID du fichier].

Cliquez sur "Try it out".
Remplissez le champ Export file ID : (pour l’exemple) 227.
Remplissez le champ Export file secured hash : (pour l’exemple) 0e5c31c4c5b1a0d93f4fa2c04a098526609b58782831b986864ecfffe11cd4be710e701b25463faad33c908567b36d752c39e369692405b7e641cde7ffe4d003
Cliquez sur le bouton "Execute".

Attention : le fichier n’est pas téléchargé, mais vous obtenez un exemple curl qui vous permet de télécharger le fichier sur votre poste de travail grâce à votre terminal.

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]

À NOTER

Les fichiers sont disponibles au téléchargement :

pendant 1 jour pour les exports simples,
pendant 7 jours pour les exports récurrents.

Personnalisez votre export

Pour personnaliser certaines données de vos exports, utilisez le endpoint PUT/api/exports/[ID de l’export].

Exemple :

{
  "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,
  "recurrenceDay": null,
  "nbOccurrence": 1,
  "endRecurrenceDay": null
  "dateUpdated": 2021-04-23 12:00:00+02
  "status": "active",
  "config": { "granularity": "transaction" }
}

Les champs personnalisables sont :

le nom du fichier "filePrefix",
les noms des colonnes "columns". Ce champ est un champ JSON, seul le libellé est personnalisable.
- Exemple : pour "merchant_order_id\":\"ID commande\", vous pouvez modifier le nom de la colonne comme ceci : "merchant_order_id\":\"ORDER\".

À NOTER

Par défaut, les titres des colonnes (champs "columns") sont dans la langue de préférence de votre interface HiPay Console.

Le séparateur "separator". Les valeurs possibles sont :
- comma : virgule
- semicolon : point-virgule
La fréquence de l’export "recurrence". Les valeurs possibles sont :
- once : une seule fois.
- daily : chaque jour
- weekly : chaque semaine
- monthly : chaque mois
La réception sur email : "receiveByEmail". Les valeurs possibles sont :
- true : vous recevrez l’export par e-mail
- false : vous ne recevrez pas d’e-mail
La configuration : "config" est un objet (JSON) vous permettant de modifier le format de votre export. Les valeurs possibles sont :
- granularity: "transaction" ou "operation" pour une vue par transaction ou par opération de paiement. Par défaut, si cette option n'est pas spécifiée, la vue de l'export se fait par transaction (export du module transaction UNIQUEMENT).

Articles associés :