CONSUMO DA API TESTE PELO SWAGGER
Antes de começar, tenha em mãos o token de acesso da API (v2.0) do merchant e api-secret-key (requestId), estas credenciais podem ser obtidas seguindo o passo 2 desta documentação.
- 1º ABRA /V2/SWAGGER/UI
Sandbox / Homologação:
URL raiz (requests) - https://gateway-nix-qa.cloudint.nexxera.com/v2
Swagger de homologação - https://gateway-nix-qa.cloudint.nexxera.com/v2/swagger/ui/index.html
NIX EMPRESAS: Se você está vindo pela documentação do Nix Empresas, saiba que sua URL raiz para homologar em ambiente QA e se integrar com seu sistema é essa: https://apigateway-qa.nexxera.com/nix-pay
Produção:
URL raiz (requests) - https://gateway-nix.nexxera.io/v2
Swagger de produção - https://gateway-nix.nexxera.io/v2/swagger/ui/index.html
NIX EMPRESAS: Se você está vindo pela documentação do Nix Empresas, sua URL raiz de produção é essa: https://api.nexxera.com/nix-pay
A seção CardPayments é a API de transações com cartão de crédito/débito. Para usar, expanda-a.
Métodos GET são usados para consulta, nenhuma alteração é feita
POST é usado para criar algo, no caso para realizar uma nova transação com cartão
PUT é usado para alteração, como cancelar uma transação ou capturar uma previamente autorizada
- 2 - CRIANDO UMA NOVA COBRANÇA E UTILIZANDO OS BODY REQUESTS
Na subseção Request Body podemos ver o formato de requisição para a transação que, neste caso, é a nova solicitação criada pelo método. Ainda nesta mesma subseção, é possível visualizar os parâmetros que compõem a requisição. Todos os métodos tem o campo Authorization como obrigatório, sendo este campo o token de acesso na API (v2.0) localizados na tela do painel NIX, acessando configurações da empresa ao lado superior direito. Em seguida, clique na aba Gateway e copia a chave em TOKEN NA API V2, conforme passo a passo.
Observação: Desconsidere a tela acima caso esteja vindo do NIX EMPRESAS.
Se o cliente optar por utilizar um token único para cada transação será necessário gerar um novo token através do link https://jwt.io/ inserindo no payload as informações conforme no exemplo abaixo:
{
"iss": "7373b255-aac3-4c1f-b64a-adcabdf0d93a",
"access":
[
"cardPayments",
"recurrencePlans",
"recurrences",
"checkout",
"boletoPayments"
]
"exp": 1516239022
}
iss: identificação do merchant/estabelecimento que está fazendo a requisição, está disponível no portal Nix Pay em Config. de empresa>Gateway na item IDENTIFICAÇÃO PARA ACESSO NA API (ACCESSKEY).
access: Se refere as permissões que o token irá conceder, sendo elas "cardPayments", "recurrencePlans", "recurrences", "checkout", e "boletoPayments", para alterar basta excluir as permissões que não deseja conceder com o token em questão.
exp: data até quando o token é válido, em formato unix (seconds since epoch). Este campo não é obrigatório.
d. Na última sessão (em azul) marcar o campo: secret base64 encoded e colar na caixa de texto secret o api-secret-key do merchant.
Dica: Ao alterar o campo secret, ficará mostrando uma área escrito “Invalid Signature”, volte a segunda coluna e modifique-a, depois desfaça a alteração (por exemplo, coloque um espaço e remova-o no final do campo). Com essa ação, o site mostra “Valid Signature“.e. Copie o valor da primeira coluna. O valor do campo Api Access key é “Bearer ” (sem aspas). Ex: Bearer eyJhbGciOiJIUzI1Ni…
- O CAMPO REQUESTID É UM UUID SE PRECISAR USE FERRAMENTAS COMO HTTPS://WWW.UUIDGENERATOR.NET/ PARA GERAR UUIDS.
Dados para testes
Utilize o seguinte ambiente para avaliação, testes e homologação: https://gateway-nix-qa.cloudint.nexxera.com/v2/swagger/ui/index.html
No ambiente de testes, não há verificação do cartão de crédito retornando sempre as transações que foram autorizadas. Ou seja, você pode gerar números de cartões inexistentes que a API retornará como Autorizada. Para realizar os testes de insucesso verifique a seguinte tabela:
Já para débito em QA, é possível testar o status de transação Iniciada e autorizada.
Em transações de boletos e PIX, é necessário encaminhar o authentication code ao time de Implantação para simularmos a liquidação.
RECOMENDAÇÕES DE SEGURANÇA PARA DESENVOLVEDORES
Não deixar a página de Checkout na área pública do seu site (ex. exigir um Login ou Cadastro Prévio);
Implementar Captcha ou outras validações no Backend para proteger contra requisições automatizadas/bots;
Desabilitar a função autocompletar dos campos do formulário;
Proteger as informações do cartão na transmissão e logs (ex. Mascaramento);
Proteger as chaves de acesso fornecidas pelo Nix. Caso necessário, sua substituição pode ser solicitada via suporte@meunix.com.br
