Neste artigo, exploraremos o funcionamento da API / Webservice do DocSales. Destacaremos a relevância dessa ferramenta para uma utilização mais eficaz do sistema, fornecendo informações fundamentais para os usuários.
Compreender como a API / Webservice do DocSales funciona é crucial para otimizar a integração de sistemas externos e a criação ou consulta de documentos de venda.
Este artigo oferecerá uma visão detalhada sobre o funcionamento dessa API. Ao entender as funcionalidades e possibilidades oferecidas, os usuários poderão integrar com facilidade sistemas externos, como CRMs ou sistemas de atendimento, para melhorar o processo de criação e consulta de documentos de vendas. Fique atento, pois em breve teremos mais funções disponíveis nessa API.
A API só está disponível em alguns planos, consulte se seu plano contempla essa função em http://www.docsales.com/planos/
São 4 endpoints:
1) Consulta de documentos por cliente (/api/v1/customers/{customer_id}/proposals)
O objetivo dessa consulta é listar todos os documentos que um determinado cliente possui.
A consulta pode ser feita por código do cliente, ID (id interno do DocSales) ou por CNPJ
O ID é o código da URL quando o cadastro de clientes é acessado (menu Clientes):
Exemplo:
O ID desse cliente é o 48011.
2) Consulta de documento (detalhada) (/api/v1/proposals/{id})
Essa consulta traz todos os detalhes de um documento de vendas. Tudo, sem exceção.
A consulta pode ser feita por ID (id interno do DocSales) ou pelo external_uuid que é o código interno que o sistema gera quando um documento é criado via API
O ID é o código da URL quando um documento é aberto em tela
Exemplo:
3) Consulta de dados cadastrais (/api/v1/registration-data)
Para que um documento de vendas seja inserido no DocSales, é necessário definir diversos parâmetros como:
Tipo de Assinatura: Papel ou Digital
Meio de Pagamento
Serviços ou Produtos
Modelo do Documento de vendas
Função dos signatários (parte, testemunha, etc)
Vendedor associado a proposta
Todos esses cadastros podem ser consultados através dessa chamada.
4) Inserção de documento de vendas
É o cadastro do documento de vendas propriamente dito que vai usar os dados do item 3) acima, além dos dados do cliente e dos signatários.
Ainda não há APIs para envio, reenvio, cancelamento e alteração de documento de vendas, que ainda precisam ser feitas manualmente.
Mas é só por enquanto, assim que a API estiver estável e funcional para os primeiros clientes, vamos liberar mais funções.
Para acessar a API, clique no menu CONFIGURAÇÕES -> Integrações
Lá você encontrará 2 funções:
TOKEN: O token é a chave (senha) de acesso para uso da API. é necessário gerar o token no primeiro uso. E a qualquer momento, é possível gerar um novo token.
REQUISIÇÕES DA API: Nessa área o DocSales registra todas as chamadas que foram realizadas na API (log) para consultas futuras e para auxiliar o time de suporte técnico a resolver eventuais problemas
LIMITE DE REQUISIÇÕES: Existe um limite de 200 requisições por mês na chamada de API de criação de novo documento. São contabilizadas apenas chamadas que foram realizadas com sucesso. Para aumentar o limite, solicitamos que entre em contato com nosso time de relacionamento pelo email [email protected]
Para documentação técnica, acesse: https://web.docsales.com/api-docs/index.html
IMPORTANTE:
A API do DocSales foi lançada na versão beta em Out-2019. Por ser uma versão de lançamento, ela pode apresentar erros e instabilidade, por isso, ao iniciar o uso, entre em contato com nosso time de relacionamento enviando um email para [email protected] e comunique seu interesse em usar a API, para que nós possamos acompanhar e te ajudar em qualquer dúvida ou dificuldade.
Para dúvidas adicionais, entre em contato com o nosso time de suporte clicando no ícone de ajuda no canto inferior esquerdo ou enviando e-mail para [email protected].
