Facilitando a Integração com a API da Paytime: O Uso do DE/PARA

Para garantir que a integração com a API da Paytime ocorra de forma fluida e eficiente, além do suporte técnico oferecido pelo nosso time de integração, é fundamental realizar um estudo conhecido como DE/PARA.

O que é o DE/PARA?

DE: Refere-se à origem dos dados, que pode ser:

  • A estrutura de dados e padrões utilizados pela API da Paytime, incluindo os campos esperados nos payloads de requisição e os retornos fornecidos pela API.
  • Ou a estrutura do seu sistema, dependendo da direção do mapeamento.

PARA: Refere-se ao destino dos dados, que pode ser:

  • A estrutura de dados do seu sistema, adaptando os padrões da Paytime para seu ambiente.
  • Ou a estrutura da Paytime, ajustando os dados do seu sistema para os padrões esperados pela nossa API.

Em outras palavras, o DE/PARA pode ser feito nas duas direções:

DE: API Paytime → PARA: Seu Sistema

DE: Seu Sistema → PARA: API Paytime

Esse processo é essencial para identificar as diferenças entre os padrões utilizados e garantir que as informações sejam transmitidas corretamente.

Por que o DE/PARA é importante?

  • Ajuda a entender como os dados devem ser traduzidos entre o seu sistema e a API da Paytime (em ambas as direções).
  • Reduz o tempo de desenvolvimento, evitando erros e inconsistências no envio e recebimento de informações.
  • Garante uma integração mais eficiente e permite o uso completo dos recursos da API.

Exemplo Prático

Nos payloads da Paytime, utilizamos os seguintes campos para dados do cliente:

{
  "first_name": "João",
  "last_name": "da Silva"
}

Em alguns sistemas, o mesmo dado pode ser representado de forma diferente, como:

{
  "primeiroNome": "João",
  "ultimoNome": "da Silva"
}

O mapeamento pode ser feito nas duas direções:

DE: API Paytime → PARA: Seu Sistema

  • first_name → primeiroNome
  • last_name → ultimoNome

DE: Seu Sistema → PARA: API Paytime

  • primeiroNome → first_name
  • ultimoNome → last_name

Esse mapeamento bidirecional garante que os dados trafeguem corretamente entre os sistemas.

Como fazer o DE/PARA?

  1. Liste todas as variáveis utilizadas pela Paytime e pelo seu sistema.
  2. Mapeie as variáveis de ambos os lados para identificar correspondências.
  3. Alinhe os formatos de dados, garantindo que as informações sejam enviadas e recebidas de forma compatível.
📘

Importante:

Realizar o DE/PARA de forma detalhada (em ambas as direções, conforme necessário) facilita o desenvolvimento, evita retrabalhos e garante que a integração com a Paytime seja concluída com sucesso.


Did this page help you?