Exportação automática através da Console API

A "Console API" pode ser acedida tanto na sua interface de teste, como na interface de produção através dos seguintes URLs.

Estágio: https://stage-console.hipay. com/api/docs
Produção: https://console.hipay.com/ api/docs

Para começar, gere uma exportação recorrente através da HiPay Console.

Pense em: escolher as suas colunas, definir a ordem dessas colunas, utilize filtros (assegure, por exemplo, que tem um filtro de data pré-definido como "Ontem"), ordene uma coluna (ou mantenha a ordenação por defeito).

Gerar uma chave temporária

Primeiro passo, gerar um token (uma espécie de chave temporária) para se identificar, utilizando a seguinte ligação:

Estágio: https://stage-console.hipay. com/api/docs
Produção: https://console.hipay.com/ api/docs

Clique no ponto final do POST/api/login.
Clique no botão "Try it out" (Experimente-o).
Clique no campo EXEMPLO VALOR | MODELO e altere os termos:

No campo "nome de utilizador": "string", coloque o seu e-mail de login na Console entre aspas em vez de "string".

No campo "password" : "string", preencha a sua palavra passe entre aspas em vez de "string" (atenção: a sua palavra passe será visível, certifique-se que está sózinho ao preenchê-la).

Clique no botão "Executar".

O seu token foi gerado. Este estará disponível na área sobre fundo negro "Response Body".

Seleccione esse token ao seleccionar as linhas entre aspas.

Copie o token (Ctrl+C no PC ou Cmd+C no Mac).

Exemplo:

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

Exemplo :

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

Recuperação dos ficheiros de exportação recorrente através da API

Agora que o seu token já está na memória do seu computador, aceda ao l’URL https://console.hipay.com/ api/docs.

Clique no botão "Autorizo".
Introduza o seu token no campo "Valor" (Ctrl+V no PC ou Cmd+V no Mac), precedendo-o de Bearer [espaço].
Clique em "Autorizar".
- A janela "Autorizações disponíveis" confirma o seu acesso.
- Feche a janela clicando na cruz, no topo superior direito.

GET / api/exportações permite listar as exportações recorrentes.

Clique em "Try it out" para recuperar a lista.
Clique em "Execute".
Uma tabela JSON aparece na parte "Response Body".

Exemplo:

[
  {
    "exportId": 139,
    "dateCreated": "2019-11-20T09:45:10+01:00",
    "exportFiles": [
      "/api/export-files/227"
    ],
    "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
  }
]

O campo "exportId" dá a referência única para as suas exportações.
O campo "exportFiles" permite conhecer a referência de um ou de vários ficheiros de exportação já gerados.

Para recuperar o ficheiro, primeiro tem que recuperar o hash de segurança encriptado, utilizando o ponto final GET/api/exports/[export ID]//[ID de l’export]/files.

Clique em "Try it out".
Preencha o campo Export ID: (para o exemplo) 139.
Clique no botão "Execute".
Uma tabela JSON aparece na parte "Response Body".

Exemplo:

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

O campo "fileId" dá-lhe a referência única dos seus ficheiros.
O campo "hash" permite-lhe descarregar o ficheiro.

Para descarregar o ficheiro, utilize o endpoint GET/api/export-files/[ID do ficheiro].

Clique em "Try it out".
Preencha o campo Export file ID: (por exemplo) 227.
Preencha o campo Export file secured hash: (para o exemplo) 0e5c31c4c5b1a0d93f4fa2c04a098526609b58782831b986864ecfffe11cd4be710e701b25463faad33c908567b36d752c39e369692405b7e641cde7ffe4d003
Clique no botão "Execute".

Atenção: o ficheiro não está descarregado, mas pode obter um exemplo curl que lhe permite descarregar o ficheiro no seu posto de trabalho graças ao seu 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]

A NOTAR Os ficheiros estão disponíveis para serem descarregados : durante 1 dia para as exportações simples e diárias, durante 7 dias para as outras frequências.

Personalize a sua exportação

Para personalizar certos dados das suas exportações, utilize o endpoint PUT/api/exports/[ID de l’export].

Exemplo:

{
  "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
}

Os campos personalizados são :

o nome do ficheiro "filePrefix",
os nomes das colunas "columns". Este campo é um campo JSON, e só a etiqueta pode ser personalizada.
- Exemplo : para "merchant_order_id\":\"ID commande\", pode modificar o nome da coluna como aqui : "merchant_order_id\":\"ORDER\".

A NOTAR Por defeito, os títulos das colunas (campos "columns") estão na língua de preferência do interface da sua Console.

O separador "separator". Os valores possíveis são:
- vírgula: vírgula
- semicolon: ponto-vírgula
A frequência da exportação "recorrência". Os valores possíveis são:
- once: uma única vez.
- daily: diário
- weekly: semanal
- monthly: mensal
- monthly_day: mensalmente na data actual
- annually: anualmente
E a recepção por email. Os valores possíveis são:
- verdadeiro: irá receber a exportação por email
- falso: não irá receber por email

Artigos associados: