Este glossário contém explicações de termos técnicos e expressões comumente utilizadas nas áreas relacionadas a integrações com as APIs da Efí.

Ambiente de Homologação

Este é o local que a Efí disponibiliza ao integrador para testar sua integração, também conhecido por “Playground” ou “sandbox”.

Todas as transações geradas neste ambiente são “fictícias”, porém têm o mesmo fluxo/mecanismo do ambiente “real”. Quer testar algo? Utilize este ambiente.

Para usar o Ambiente de Homologação (sandbox), use suas chaves “Client_Id” e “Client_Secret” da aba “Homologação” e mantenha o valor de sandbox como true.

Agora, caso tenha terminado seus testes e queira colocar em produção (ambiente real), você deve alterar as seguintes informações em sua integração:

Fornecer o “Client_Id” e o “Client_Secret” da aba “Homologação” (veja onde); e
Definir a variável “sandbox” com o valor true

Ambiente de Produção

Este é o ambiente “real” que sua aplicação deverá estar para gerar cobranças (ou “transações”) “reais”.

É importante que, primeiro, você teste tudo que precisar no ambiente de homologação e, somente após conferir que sua integração está funcionando adequadamente, migre para o ambiente de produção.

Para usar o Ambiente de Produção (real), use suas chaves “Client_Id” e “Client_Secret” da aba “Produção” e mantenha o valor de sandbox como false.

Agora, caso sua aplicação esteja em produção e você precise testar algo em sua integração no ambiente de homologação, altere as seguintes informações em sua integração:

forneça o “Client_Id” e o “Client_Secret” da aba “Produção” (veja onde); e
defina a variável “sandbox” com o valor false.

API

Uma API, de Application Programming Interface (em português: Interface de Programação de Aplicativos), é um conjunto de rotinas, protocolos e ferramentas para construir aplicações.

A API da Efí foi desenvolvida para ser flexível e permitir que você coloque suas ideias em prática rapidamente. Disponibilizamos em nossa documentação da API uma tabela (vide link) com as diversas formas que você possui para cobrar seu cliente, inclusive via integração com a nossa API.

Client Id e Client Secret

Estão relacionados às chaves para autenticar com o servidor de autorização. Um integrador pode criar inúmeras aplicações em sua conta Efí e cada aplicação criada tem um par de chaves Client_Id e Client_Secret, tanto para ambiente de homologação quanto de produção.

Dessa forma, você consegue, por exemplo, informar seu Client_Id e Client_Secret de “Homologação” e testar sua aplicação antes de colocá-la em ambiente de produção e, assim, é possível certificar-se que sua implementação está correta e suas integrações estão comunicando da forma como deveriam.

Endpoint

Um endpoint é como um endereço completo na internet que leva você a um lugar específico em um site ou em um serviço online.

Por exemplo, quando você acessa um site como "https://dev.efipay.com.br/docs/api-cobrancas/credenciais", o "/credenciais" é o endpoint que leva você à página da nossa documentação que obtém informações sobre credenciais e autorização da API Cobranças.

Da mesma forma, em uma API um endpoint é a parte da URL que representa um recurso ou uma função específica que você deseja acessar. É como escolher a opção certa em um menu para realizar uma ação específica.

Por exemplo, em nossa API de cobranças, o endpoint "/v1/charge/one-step" pode ser usado para criação de boleto em um único passo.

Resumindo, um endpoint é como um endereço completo que indica exatamente onde você quer ir ou o que você quer fazer em um serviço online ou em uma API.

Método

O método é o verbo que você usará para interagir com o recurso. Normalmente, você tem 4 opções para interagir:

GET, que pede ao servidor o recurso;
POST, que pede ao servidor que crie um recurso novo;
DELETE, que pede ao servidor que apague um recurso;
PUT, que pede ao servidor a atualização ou edição de um recurso.

Caso queira conhecer mais a respeito, veja neste link.

payee_code

Esse é o identificador da conta Efí. Cada conta possui um identificador único. Independente se o integrador possui uma ou dezenas de aplicações criadas, o identificador da conta é único.

O payee_code é necessário para permitir pagamentos com cartão de crédito (para obtenção do payment_token) e para operações de marketplace.

Para localizá-lo acesse o menu API -> Aplicações -> Introdução -> Identificador de conta. Confira aqui onde localizá-lo.

Payment Token

Para transações com cartão de crédito, é realizada uma etapa prévia à criação da cobrança, onde ocorre a geração do payment_token, que representa os dados do cartão da pessoa pagadora.

O payment_token é único por cobrança mas caso você precise reutilizá-lo para fins de recorrência, pode utilizar o atributo reuse com o valor booleano true.

Dessa forma, o payment_token pode ser usado em mais de uma transação de forma segura, sem a necessidade de salvar os dados do cartão.

Clique aqui e veja como obter o payment_token.

Playground

O Playground é o ambiente de testes (sandbox online) do Efí. Trata-se de um local no qual o integrador, independente da operação a ser realizada, pode utilizar para conhecer o mecanismo e o fluxo de pagamento em um ambiente 100% de teste e descomplicado.

Ou seja, por oferecer uma paridade com os recursos suportados pela API no ambiente de produção, é possível efetuar testes de integração antes de ir para produção, podendo assim fazer uma experiência com nossa API sem fazer alterações em sua conta Efí.

Conheça mais sobre o Playground neste link.

Para ter acesso ao Playground, será necessário criar uma aplicação em sua conta. Após criar a aplicação, acesse a aba Homologação → Playground. Esta tela mostra todos os endpoints disponibilizados pela API Emissões, ou seja, tudo que é possível fazer via integração.

Token de Notificação

Trata-se do token que é enviado pela Efí via POST para a URL de notificação cadastrada pelo integrador sempre que uma cobrança (também chamado de transação) sofrer alteração de status (de “aguardando” para “paga”, por exemplo). Para verificar quais foram as alterações, é preciso consultá-las, utilizando o token de notificação enviado.

A qualquer momento que o integrador consultar esse token de notificação, irá obter as informações mais atuais da transação, todas ordenadas de acordo com os acontecimentos. Toda alteração em status gera uma notificação. Cada cobrança possui um token de notificação que será o mesmo durante todo o “ciclo de alterações” dessa cobrança.

O POST será uma informação semelhante a esta:

$_POST['notification'] = "435e1d24-b761-4afc-a5a8-ebc50b5ui78e";

Com esse token, o sistema deve utilizar a função getNotification(:token) para obter todas as alterações de status da transação.

Conheça mais sobre notificações neste link.

Central de ajuda

Como podemos ajudar você?

Fale conosco

Compartilhe