Comece por aqui
Prepare sua credencial de Sandbox e faça a primeira chamada à API da Raims.
Antes de testar
O console interativo desta documentação aceita somente credenciais de
Sandbox, com prefixo sk_test_.
Para testar, selecione ou informe uma chave de Sandbox. Consulte Chaves de API para criar e proteger sua credencial.
A Referência da API reúne os endpoints, os parâmetros, as respostas e os exemplos de código da Raims. O console permite preencher os dados de uma requisição, enviá-la para teste e consultar a resposta na mesma página.
Você pode escolher a linguagem do exemplo e copiar a requisição para adaptar ao seu sistema. Os exemplos acompanham os valores informados nos campos.
Preparando sua integração?
Consulte os guias de Chaves de API e Webhooks para entender a configuração e os cuidados da integração. Use a Referência da API para consultar os detalhes de cada requisição durante a implementação.
Para interpretar os códigos dos recursos e os prefixos dos IDs, consulte o mapa de tipos e identificadores, na área Guias.
URL base
A URL base da API da Raims é:
https://api.raims.comSandbox e Produção usam o mesmo endereço. O ambiente é definido pela credencial enviada na requisição.
Ambientes da API
Sandbox e Produção pertencem à mesma empresa, com dados e credenciais separados. A chave identifica a empresa e o ambiente da solicitação; esses valores não são escolhidos no corpo da requisição.
| Ambiente | Prefixo da credencial | Uso |
|---|---|---|
| Sandbox | sk_test_ | Desenvolvimento, homologação e testes no console da documentação, sem movimentar dinheiro real. |
| Produção | sk_live_ | Requisições com efeitos reais na conta, enviadas pelo seu sistema fora do console da documentação. |
Confira o método e o endereço completo exibidos na página de cada endpoint. Use esse endereço nos testes e nos exemplos da integração. Antes de usar Produção, confira a credencial e a configuração da sua aplicação.
Para testar o pagamento aprovado ou a falha de uma cobrança sem movimentar dinheiro real, use o recurso Simulação. Esses endpoints aceitam somente Sandbox. As demais requisições continuam nas páginas dos respectivos recursos, com a chave do ambiente de teste.
Autenticação
Consulte o guia de Autenticação para configurar os headers, escolher a chave do ambiente e revisar o acesso da integração.
A API usa o header Authorization com o esquema HTTP Bearer:
Authorization: Bearer sk_test_...sk_test_... é apenas um placeholder. No console, informe o valor completo da
sua chave de Sandbox no campo Credenciais. O exemplo monta o header de
autenticação para você.
As restrições de IP configuradas para a chave também valem nos testes. Uma
origem fora das faixas autorizadas recebe 403. Consulte
Restrições de IP antes de alterar
essa configuração.
O console não salva sua chave no navegador. No seu sistema, guarde o segredo no servidor responsável pela integração e não o exponha no navegador, em repositórios ou em logs.
Como usar o console
- Na barra lateral, escolha o endpoint que deseja testar. Confira o método, o endereço e as regras dos campos.
- Selecione ou informe uma credencial de Sandbox em Credenciais.
- Preencha os campos obrigatórios e os dados opcionais que pretende enviar. Os valores sugeridos nos placeholders não são enviados automaticamente. Se faltar um campo obrigatório, o console aponta o campo antes de enviar.
- Escolha a linguagem para conferir o exemplo e selecione Experimentar.
- Confira o status HTTP e o corpo no painel Resposta. A seção Respostas, no fim da página, detalha os resultados previstos.
Para consultar um exemplo sem enviar uma requisição, expanda um status em Respostas. O painel Resposta mostra o exemplo correspondente, quando ele estiver definido para o endpoint.
Se a credencial estiver inválida, corrija o campo antes de testar. Se aparecer um aviso sobre credenciais de Produção, substitua a chave por uma credencial de Sandbox.
Consulte Códigos HTTP das respostas para entender os erros gerais, o formato das respostas e os cuidados ao repetir uma requisição. Mesmo com erro ou conexão interrompida, a requisição pode ter sido processada. Confira o resultado antes de tentar novamente.