API - Integracao de Aplicativos
O NextBilling fornece uma interface RESTful para integrar com as funcionalidades adicionais e consumo de informações do sistema.
Ela é utilizada para consumo de informações, utilização de funcionalidades e outras opções. Utilize nosso Manual para se familiarizar com todas as opções disponíveis.
Autenticação
Para utilizar esse serviço, a autenticação é realizada utilizando os níveis de Master, Revenda ou Assinante, onde, cada acesso pode requerer um nível diferente de permissões.
Um exemplo disso é quando você precisa cadastrar um novo Assinante na plataforma, que irá exigir um Token de Acesso do Nível Master. Para criar ou adicionar uma Nova Linha IP na Plataforma, você poderá realizar essa operação utilizando um Token do nível Assinante bem como um Token do Nível Master.
Os Tokens de acesso a API são encontrados na tela de um usuário do sistema, como mostra a imagem abaixo:
|
|
Com posse dos Tokens de acesso, é hora de colocar a mão na massa e fazer alguns testes
NOTA
Você pode baixar na sua Plataforma o Playground que contém alguns exemplos prontos de como utilizar a API. Acesse o menu e digite integração e faça o download.
Respostas de Erro
A API pode retornar os seguintes códigos de erro:
- 400 Bad Request - a solicitação está incompleta e não pôde ser processada
- 403 Access Denied - a autenticação não está correta, verifique o token utilizado
- 404 Not Found - a opção que está tentando acessar não existe
- 413 Request entity too large - a solicitação excede o tamanho máximo permitido de 128kb
- 422 Unprocessable Entity - a solicitação é válida mas algum parâmetro necessário não está presente
- 429 Too many Requests - você está enviando várias solicitações ao mesmo tempo
Tópicos dessa Sessão
- 0 - Utilizando o Playground
- Agenda de Contatos - Clientes
- Alterando a Senha de uma Linha IP
- Alterando a Senha de um Cliente
- Alterando uma Conta de Assinante
- Alterando uma Linha IP
- API para exibir Saldo no Softphone
- Ativar-Desativar uma Linha IP
- Ativar-Desativar um Cliente
- Click2Call - 0800Web
- Consultar saldo da Linha pelo Equipamento
- Consultar saldo de um Cliente
- Criando-Alterando um DID
- Criando uma nova Linha IP
- Criando um novo Assinante
- Enviando SMS pela API
- Excluindo uma Conta de Assinante
- Excluindo uma Linha IP
- Excluindo um DID
- Gerenciar Saldo de Clientes-Linhas
- Listar Arquivos de Audio
- Listar Assinantes por Revenda
- Listar Chamadas em Andamento
- Listar Codecs de Equipamentos
- Listar DIDs - Numeros Entrantes
- Listar Filas de Atendimento
- Listar Linhas IP - Ramais
- Listar Linhas IP Registradas
- Listar Menus de URA - IVR
- Listar Perfil de Acesso
- Obter o Cadastro de uma Linha IP
- Obter o Cadastro de um Cliente
- Relatorio de Chamadas - CDR
- Relatorio de Chamadas DID - CDR
- Relatorio de Gravação de Chamadas
- Relatorio de Notas de Atendimento - URA
- Script para Login pelo Site
- Vincular Numero DID a um Assinante