/sdk-go-apis-efi

Primary LanguageGoMIT LicenseMIT

SDK Go para APIs Efí Pay

Banner APIs Efí Pay

Português | Inglês

SDK em GoLang para integração com as APIs Efí para emissão de Pix, boletos, carnês, cartão de crédito, assinatura, link de pagamento, marketplance, Pix via Open Finance, pagamento de boletos, dentre outras funcionalidades. Para mais informações sobre parâmetros e valores/tarifas consulte nosso site.

Ir para:

Testado com

go 1.8, 1.11.4, 1.16.5 and 1.19.2

Instalação

Clone este repositório e execute o seguinte comando para instalar as dependências

go mod init github.com/efipay/sdk-go-apis-efi

Começando

Para começar, você deve configurar as credenciais no arquivo /examples/configs/configs.go. Instancie as informações client_id, client_secret para autenticação e sandbox igual a true, se seu ambiente for Homologação, ou false, se for Produção. Se você usa cobrança Pix, informe no atributo CA e Key o diretório absoluto e o nome do seu certificado e chaves, no formato .pem.

Veja exemplos de configuração a seguir:

Para ambiente de homologação

Instancie os parâmetros do módulo usando client_id, client_secret, sandbox igual a true e CA e Key obtidos através do certificado de homologação:

var Credentials = map[string]interface{} {
	"client_id": "",
	"client_secret": "",
	"sandbox": true,
	"timeout": 20,
	"CA" : "", //caminho da chave publica 
	"Key" : "", //caminho da chave privada 
}

Para ambiente de produção

Instancie os parâmetros do módulo usando client_id, client_secret, sandbox igual a false e CA e Key obtidos atravéd do certificado de produção:

var Credentials = map[string]interface{} {
	"client_id": "",
	"client_secret": "",
	"sandbox": false,
	"timeout": 20,
	"CA" : "", //caminho da chave publica 
	"Key" : "", //caminho da chave privada 
}

Como obter as credenciais Client-Id e Client-Secret

Crie uma nova aplicação para usar as APIs Efí Pay:

  1. Acesse o painel da conta digital Efí no menu API.
  2. No menu lateral, clique em Aplicações depois em Criar aplicação.
  3. Insira um nome para a aplicação, e selecione qual API quer ativar: API de emissões (boletos e carnês) e/ou API Pix e/ou Pagamentos. Neste caso, API Pix;que estes podem ser alterados posteriormente).
  4. selecione os Escopos de Produção e Escopos de Homologação (Desenvolvimento) que deseja liberar;
  5. Clique em Criar aplicação.
  6. Informe a sua Assinatura Eletrônica para confirmar as alterações e atualizar a aplicação.

Como gerar um certificado Pix

Todas as requisições do Pix devem conter um certificado de segurança que será fornecido pela Efí dentro da sua conta, no formato PFX(.p12). Essa exigência está descrita na íntegra no manual de segurança do PIX.

Para gerar seu certificado:

  1. Acesse o painel da conta digital Efí no menu API.
  2. No menu lateral, clique em Meus Certificados e escolha o ambiente em que deseja o certificado: Produção ou Homologação.
  3. Clique em Criar Certificado.
  4. Insira sua Assinatura Eletrônica para confirmar a alteração.

Para separar a chave privada e o certificado com OpenSSL:

openssl pkcs12 -in path.p12 -out newfile.crt.pem -clcerts -nokeys #certificado
openssl pkcs12 -in path.p12 -out newfile.key.pem -nocerts -nodes #chave privada

⚠️ O processo de conversão do certificado pode pedir a senha do certificado. Se isso ocorrer, informe vazio.

Como cadastrar as chaves Pix

O cadastro das chaves Pix pode ser feito através do aplicativo mobille da Efí, conta digital web ou por um endpoint da API. A seguir você encontra os passos de como registrá-las.

Cadastrar chave Pix pela conta digital web:

  1. Acesse sua conta digital.
  2. No menu lateral, clique em Pix.
  3. Clique em Minhas Chaves e depois clique no botão Cadastrar Chave.
  4. Você deve escolher pelo menos 1 das 4 opções de chaves disponíveis (CPF/CNPJ, E-mail, Celular ou Chave aleatória).
  5. Após cadastrar as chaves do Pix desejadas, clique em Continuar.
  6. Insira sua Assinatura Eletrônica para confirmar o cadastro.

Cadastrar chave Pix através da API:

O endpoint utilizado para criar uma chave Pix aleatória (evp), é o POST /v2/gn/evp (Criar chave evp). Um detalhe é que, através deste endpoint é realizado o registro somente de chaves Pix do tipo aleatória.

Para consumí-lo, basta executar o exemplo /examples/exclusive/key/pixCreateEvp.go da nossa SDK. A requisição enviada para esse endpoint não precisa de um body.

A resposta de exemplo abaixo representa Sucesso (201), apresentando a chave Pix registrada.

{
  "chave": "345e4568-e89b-12d3-a456-006655440001"
}

Documentação Adicional

A documentação completa com todos os endpoints e detalhes das APIs está disponível em https://dev.sejaefi.com.br/.

Se você ainda não tem uma conta digital Efí Bank, abra a sua agora!

Licença

MIT