DCS (Digivox Cloud Service) API

O Digivox Cloud Service (DCS) é uma solução exclusivamente em nuvem que funciona como uma provedora de APIs. Ao utilizar o DCS, os clientes podem integrar seus próprios serviços com canais de atendimentos como WhatsApp, Facebook e Instagram por meio de um serviço de comunicação centralizado.

Este guia explica como realizar cadastros de clientes, licenças e integrações no DCS através da API, além de mostrar os webhooks que são enviados pelo DCS trazendo mensagens e comentários postados pelos clientes finais nas redes sociais integradas.

Formato

As informações necessárias devem ser especificadas utilizando um formato JSON e em protocolo HTTPS.

O path para fazer chamadas depende do URL do ambiente em que a API será usada, somado a /api/v1 no final do endereço. Exemplo: https://ambiente/api/v1.

Autenticação

Ao cadastrar um novo cliente via API, será retornado o access-token a ser usado como método de autenticação para todas as outras chamadas. Para realizar esse cadastro de cliente, deve ser feita uma basic auth, com username e password informados pelo DCS.

Em caso de perda ou comprometimento do token, é necessário entrar em contato com o suporte para obter um novo certificado digital.

Resumo de respostas

A tabela abaixo apresenta um resumo das respostas padrão da API do DCS: Sucesso (200), Criado (201) Requisição Inválida (400), Não Autorizado (401), Acesso Proibido (403) e Erro Interno do Servidor (500).

Código de Status	Descrição do Status	Mensagem de Exemplo
200	Sucesso	Requisição bem-sucedida
201	Criado	Requisição bem-sucedida: novo recurso criado
400	Requisição Inválida	Erro na requisição: parâmetros inválidos
401	Não Autorizado	Erro de autenticação: acesso negado
403	Acesso Proibido	Acesso proibido: permissões insuficientes
500	Erro Interno do Servidor	Erro interno do servidor: tente novamente mais tarde

Clientes

Antes de preencher os campos no corpo da requisição, é necessário entender sobre os tipos de cliente, que podem ser Direto, Parceiro ou Indireto.

Cliente Direto: É o que tem pagamentos e tratativas realizadas de forma direta com a Smartspace by Digivox.
Smartspace by Digivox.

Cliente Parceiro: Tem pagamentos e tratativas realizadas de forma direta com a Smartspace by Digivox, mas os serviços e
soluções são entregues a terceiros (clientes finais).

Cliente Indireto: Realiza pagamentos e tratativas de forma indireta com a Smartspace by Digivox. Passa primeiro pelo
Parceiro, mas os serviços e soluções Smartspace by Digivox são
entregues diretamente a ele.

Confira os endpoints referentes ao gerenciamento de clientes do DCS.