Este artigo apresenta a API do Parceiro.
Neste artigo você vai encontrar os seguintes tópicos:
Introdução
A API do Parceiro é um conjunto de métodos que permite a consulta, criação e alteração das empresas do parceiro.
OBS: Note que a API do Parceiro não permite a integração de registros como clientes e produtos de cada empresa.
Vídeo de Apresentação
Métodos da API
A API do Parceiro oferece os seguintes métodos:
- Obter lista de empresas:
- Retorna uma lista com todas as empresas do parceiro.
- Criar nova empresa:
- Permite a criação de uma nova empresa.
- Alterar empresa
- Permite a alteração dos dados cadastrais de uma empresa.
- Extrato de faturamento
- Retorna o detalhamento do extrato de faturamento de determinado mês.
Dúvidas Frequentes
Como obter o token de parceiro?
Para obter o seu token de parceiro, entre no menu Consultas Token da API do Parceiro.
Como testar a API?
Para facilitar os testes criamos uma collection que você pode importar diretamente no Postman.
Link da Collection: https://www.getpostman.com/collections/0e1ecc7e1a0ef56a9e42
OBS: Sugerimos utilizar o Postman direto na Web: https://www.postman.com/, basta criar a conta e importar a collection, configurar o seu token e testar a API.
Qual a diferença dessa API com a integração que já temos em cada empresa?
São duas coisas diferentes:
- A integração de cada empresa (usando o Layout de Integração e Sincronizador) permite a integração das tabelas de dados de determinada empresa, nesse caso é usado o Token da Empresa.
- A API do Parceiro por sua vez permite a consulta, alteração e criação de novas empresas.
Posso utilizar o token de parceiro no Sincronizador?
Não, o sincronizador precisa de um token de empresa.
Posso usar o token da minha empresa de testes na API do Parceiro?
Não, a API do parceiro precisa de um Token de Parceiro.