Criar um backend
Um backend é uma simulação publicada que serve os provedores que você escolher. Esta página leva ele do nada até uma URL que a sua integração pode chamar.
Antes de começar
Você precisa de um provedor. Um backend tem que servir alguma coisa, e ele só serve marcas que a sua organização já tem.
Veja Adicionar provedores.
O seu plano tem que permitir um backend, e o app avisa na página Backends quando ele não permite. Um backend é uma simulação como qualquer outra, então ele também sai da mesma cota de simulações do resto do seu trabalho.
Quem tem o papel de editor ou acima cria um. Comprar provedores é só para owner, mas montar um backend com o que a organização já tem não é.
Crie
Abra Backends e use Novo backend na linha do tipo que você quer. Dá para começar também por Simulações, onde os backends ficam junto de todo o resto.
Três campos:
- Tipo é pagamentos ou identidade. Não dá para mudar depois, porque ele decide qual motor roda.
- Nome é para você, e é o que o app lista. Mude quando quiser.
- Segmento da URL é parte do endereço. Em minúsculas, no máximo 15 caracteres.
O segmento fica editável até o primeiro deploy e é fixado depois dele. Isso é de propósito: ele fica no meio da URL que o seu código chama e prefixa tudo que o backend registra, então renomear depois quebraria as integrações no ar e deixaria os registros órfãos ao mesmo tempo.
Criar um backend ainda não serve nada. Ele não tem provedor até você escolher, e um backend sem nenhum é recusado no deploy.
Escolha o que ele serve
Abra o backend e vá em Provedores. Aparece tudo que a organização tem, e você marca o que este serve.
Escolha no nível que servir:
- A marca, tipo Adyen, que cobre toda API e versão abaixo dela.
- Uma API daquela marca.
- Uma versão exata, tipo
adyen/checkout/v71.
Marcar a marca cobre tudo abaixo dela, e as linhas mais estreitas dizem isso em vez de deixar você marcar a mesma coisa duas vezes. Selecionar tudo pega toda marca que você tem.
Aqui só aparecem as marcas que a sua organização tem. Se o build que o backend roda não entrega mais alguma delas, ela fica marcada e não pode ser escolhida.
Rodar mais de um backend com escolhas diferentes é normal. Se um backend serve uma marca só, toda requisição nele chega naquele fornecedor e em nenhum outro, que é o que você quer quando um teste é sobre uma integração.
Faça o deploy
Fazer deploy coloca o backend no ar. Nada é servido até você fazer, e as mudanças de provedor chegam num backend no ar do mesmo jeito: salve, depois faça o deploy.
A pílula de status caminha até Ativa e a URL começa a responder. O primeiro deploy demora mais que os seguintes, já que o runtime está sendo colocado.
O endereço segue o padrão que toda simulação usa, com cada provedor no próprio prefixo:
https://<domínio>/pay/<sua-org>/<nome>/adyen/checkout/v71/payments
https://<domínio>/kyx/<sua-org>/<nome>/onfido/v3.6/applicantsTudo depois do prefixo é o caminho do próprio provedor, então apontar a sua integração para o backend é trocar a URL base e mais nada.
Configurações que vale conhecer
Geral guarda o nome, o segmento da URL e o Comportamento, que controla o que o backend faz além de responder:
- Explorador de API mostra uma interface navegável na URL do backend. Desligue e só a API responde.
- Gravar tráfego guarda cada requisição e cada resposta, que é o que enche o Histórico. Guardar por é quanto tempo elas duram.
- Replay grava uma resposta uma vez e depois responde com ela nas requisições que corresponderem.
Deploy é onde ele roda, e Acesso é quem alcança ele. Os dois se comportam como em qualquer simulação.
Veja Controle de acesso.
Depois que ele está no ar
O backend guarda um registro do que já fez, que dá para percorrer por provedor.
Veja Atividade do backend.
Por padrão ele segue o build publicado mais recente. Fixe ele em um build se uma suíte de testes precisar das mesmas respostas ao longo do tempo.
Veja Fixar uma versão de build.