Criar um backend hospedado
Um backend hospedado é um backend que a gente roda para você. Ele serve os provedores que você escolhe e responde num endereço próprio, então a sua integração chama ele do mesmo jeito que chama o provedor. Esta página vai da criação até um endereço que você pode chamar.
Para rodar um backend na sua própria rede, veja a seção de self-hosted.
Veja Visão geral dos backends self-hosted.
O vídeo cria um backend hospedado para Stripe e PayPal e adiciona uma regra que recusa US$ 66,60 como fraude. Depois faz o deploy e aponta uma lojinha para ele. Na loja, só o endereço da API muda.
Antes de começar
Você precisa de um provedor do tipo que quer rodar. O backend só pode servir marcas que a sua organização tem.
Veja Adicionar provedores.
O seu plano precisa permitir um backend, e a Loja de backends avisa quando não permite. Além disso, cada backend conta como uma simulação no limite do seu plano.
Qualquer pessoa com o papel de editor ou acima pode criar um. Só a compra de provedores fica com os owners.
Criar o backend
Abra a Loja de backends, ache o tipo em Tipos e use Novo backend ali. Você também pode abrir Simulações, usar a seta ao lado de Nova simulação e escolher Backend.
O diálogo tem três campos:
- Tipo: pagamentos ou identidade. Só aparecem os tipos dos quais você tem um provedor, e o tipo não pode mudar depois.
- Nome: é para você, e é o que as listas mostram. Mude quando quiser.
- Nome de host: a primeira parte do endereço do backend, tipo
shop-paymentsemshop-payments.pay.mockz.io. Ele segue o nome enquanto você digita, até você editar.
Um nome de host tem de 3 a 63 caracteres: letras minúsculas, dígitos e hífens sozinhos. Não dá para usar palavras que a gente reserva, tipo api ou admin, nem o nome de um provedor, tipo adyen ou stripe, nem um nome de host que outra organização já usa. Você pode mudar até o primeiro deploy. Depois ele fica fixo.
Criar um backend não faz deploy de nada. Ele abre em Provedores, ainda sem nada selecionado.
Escolher o que ele serve
Provedores lista cada marca desse tipo que a sua organização tem. Selecione o que este backend serve. A mudança é salva sozinha.
Escolha no nível que fizer sentido:
- A marca, tipo Adyen, que cobre cada API e cada versão abaixo dela.
- Uma API dessa marca, tipo checkout.
- Uma versão exata, tipo v71.
Selecionar uma marca cobre as linhas abaixo dela, e essas linhas mostram isso. Selecionar tudo pega cada marca que você tem. Uma linha marcada Não está neste build é algo que o build do backend não inclui, e não dá para escolher.
Imagem base, no canto de cima à direita, é o build que o backend roda. Por padrão é o build mais recente.
Veja Fixar uma versão de build.
É normal rodar mais de um backend com seleções diferentes. Um backend que serve uma marca só manda cada requisição para esse provedor e para nenhum outro. É disso que um teste sobre uma única integração precisa.
Fazer o deploy
Use Fazer deploy no cabeçalho. O status passa de Fora do ar para Fazendo deploy e depois para Ativa. O endereço aparece embaixo do nome, com botões para copiar ou abrir. O primeiro deploy demora mais que os seguintes.
O que você mudar depois, tipo os provedores, as configurações ou os cenários, é salvo na hora e chega ao backend no próximo deploy.
Se um deploy for recusado, a página diz por quê. O motivo mais comum é um backend sem nenhum provedor selecionado.
Onde ele responde
Um backend hospedado responde no seu próprio host:
- Pagamentos:
https://<hostname>.pay.mockz.io - Identidade:
https://<hostname>.kyx.mockz.io
Cada versão de um provedor responde sob o seu próprio caminho nesse host, tipo /adyen/checkout/v71. Tudo depois desse caminho é a rota do próprio provedor, então uma requisição de pagamento fica assim:
POST https://shop-payments.pay.mockz.io/adyen/checkout/v71/paymentsO SDK de um provedor manda as requisições dele para a raiz (/) de um host. Para usar um, coloque a versão certa na raiz: abra Configuração do serviço, escolha a versão, apague o caminho dela e aperte Enter. Aí ela também responde em https://shop-payments.pay.mockz.io/payments, e continua respondendo no caminho dela.
Para colocar o backend em outro dos nossos domínios, escolha o domínio em Host, dentro de Deploy, e salve antes do primeiro deploy. O host e o nome de host ficam fixos a partir do primeiro deploy.
Configurações que vale conhecer
Geral tem o nome, o ícone e Comportamento, que controla o que o backend faz além de responder:
- Explorador de API: uma interface navegável no endereço do backend. Se você desligar, só a API responde.
- Gravar tráfego: guarda cada requisição e cada resposta, e é isso que preenche o Histórico. Fica desligado até você ligar. Guardar por é quanto tempo elas ficam, até o que o seu plano permite.
- Replay: grava uma resposta uma vez e responde com ela às requisições que batem. Tem o seu próprio Guardar por: quanto tempo uma gravação fica guardada, 24 horas se você não mudar.
Acesso decide quem pode chegar ao backend, com uma API key, uma senha para o explorador ou uma lista de IPs permitidos. Funciona igual a qualquer simulação.
Veja Controle de acesso.
Tirar do ar
Um backend que você não está usando pode sair do ar. Use a seta ao lado de Fazer deploy e escolha Tirar do ar. O endereço para de responder, e tudo o que você configurou fica. Fazer deploy traz ele de volta.
Apagar um backend, em Geral, remove ele de vez. Se ele já passou por deploy, o nome de host fica com a sua organização por 90 dias, para ninguém mais pegar enquanto isso.
Depois que ele está no ar
O backend guarda um registro do que fez, tipo os pagamentos que recebeu, e a barra lateral dele lista isso.
Veja Atividade do backend.