Acessar e Autenticar
João M Nguimbi
Last Update há 4 anos
1. URL
2. Autenticação
2.1. Localizando sua ID de revendedor
2.2. Localizando sua chave de API
2.3. Whitelisting your IP Address (es)
3. Testando / Tentando a API
3.1. O URL do teste
————————————————————————————————————————— ——————————————————————————————————–
URL
A API HTTP está disponível em:
Por motivos de segurança, você sempre deve enviar pedidos de API usando HTTPS.
Autenticação
Todos os pedidos exigem os seguintes parâmetros de autenticação:
auth-userid: seu ID de Revendedor de conta real (veja as instruções abaixo para encontrar seu ID de revendedor).
api-key: um código alfanumérico que pode ser usado para autenticar suas chamadas API (veja as instruções abaixo para encontrar sua chave API)
Localizando seu ID de revendedor
Faça login no painel de controle do Revendedor/Cliente.
Clique no ícone no canto superior direito da página e clique em Gerenciar perfil.
Na vista Detalhes do perfil do revendedor que agora é exibida, o primeiro campo indica o seu ID do revendedor.
Localizando sua chave de API
Faça login no painel de controle do revendedor.
No menu, aponte para Configurações e clique em API.
Clique no link Ver chave da API na seção Chave da API. Sua chave de API exclusiva será exibida em uma janela pop-up em uma conexão segura.
Você pode gerar uma nova API Key clicando no link Regenerate.
A geração de uma nova API Key invalidará sua chave API antiga imediatamente e isso afetará suas chamadas de API existentes. Tenha cuidado ao gerar uma nova chave de API.
Colocando seu IP na WhiteList
Faça login no painel de controle do revendedor.
No menu, vá para Configurações e clique em API.
Sob a WhiteList da sua lista de endereços IP, especifique os endereços IP a partir do qual você estará fazendo solicitações de API e, em seguida, clique no botão Salvar endereços de IP.
Os intervalos de IP e netblocks não são aceitos.
Testando / tentando a API
A API HTTP exige que todas as solicitações para recuperar dados devem usar o método GET e solicita que enviar, alterar ou destruir dados deve usar o método POST. Os pedidos que exigem um método HTTP particular retornarão um erro se você não fizer seu pedido com o método correto.
No entanto, para tornar mais fácil para você testar e testar a API usando o navegador ou as ferramentas de linha de comando, disponibilizamos um URL de teste especial que permite que você faça qualquer pedido usando o método GET. Exemplo de solicitações de URL de teste são fornecidos para todos os pedidos de API.
O URL do teste
O URL de teste só deve ser usado para testar ou testar a API através das ferramentas do navegador / linha de comando e não deve ser usado em ambientes de produção.
Recomendamos sempre o uso de um ID e Senha do Revendedor de Conta Demo com o URL do Teste para autenticação em relação ao uso de suas credenciais de Conta Vivo. O uso de suas credenciais da Conta ao vivo, mesmo com o URL do teste, resultará em ações que serão realizadas em ambientes de produção.
informação adicional
Inscreva-se para uma conta de revendedor de demonstração
Em caso de erros, um status HTTP 500, juntamente com uma mensagem de erro relevante será retornado.