Autenticação¶
Toda requisição precisa da sua chave e senha de webservice, enviadas como parâmetros.
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
chave |
Sim | Chave de webservice fornecida pela SuiteCred |
senha |
Sim | Hash MD5 da sua senha de webservice (com typePass=1) |
typePass |
Sim | Sempre 1. Indica que a senha já está em MD5 |
ws |
Sim | Sempre sim. Indica integração via API |
Como gerar a senha em MD5¶
$senha = md5('SUA_SENHA');
const crypto = require('crypto');
const senha = crypto.createHash('md5').update('SUA_SENHA').digest('hex');
echo -n 'SUA_SENHA' | md5sum | cut -d' ' -f1
Proteja suas credenciais
O hash MD5 da senha vale como a própria senha para a API. Trate os dois com o mesmo cuidado: não registre a URL completa em logs da sua aplicação e não exponha as credenciais no navegador do usuário final.
Saldo e limite¶
Cada consulta é cobrada da sua conta. Se não houver saldo (conta pré-paga) ou limite (conta pós-paga), a API responde com erro e a consulta não é feita. Veja as mensagens em Respostas e erros.