Public
Documentation Settings

API's para Terceiros - ERPVoalle

Nessa coleção estão documentadas as API's disponibilizadas pela Voalle agrupadas por seus relativos módulos do ERP e funcionalidades.

Todas as API's desta coleção estão em um ambiente separado do ERP Voalle e devido a isso o usuário que será utilizado na API de autenticação para obter o access_token a ser informado nas demais requisições, deve ser identificado como um usuário de Integração e assim, não será possível usar esse usuário para acessar a interface do ERP.

Ao acessar a rotina Configurações / Usuários e cadastrar um novo usuário, marcar a opção Usuário integrador. Quando marcado esse campo, esse usuário não irá conseguir logar no ERP, apenas na API Third Party. Caso não marcado, a API de autenticação irá retornar o status Não Autorizado.

Todas as requisições feitas via API ao ERP Voalle irão gerar um log da transação e da ação realizada em nome do usuário autenticado. Com isso, é altamente indicado que seja criado um novo usuário para cada integração que irá acessar o ERPVoalle.

Autenticação

POSTAutenticação - Legado

{{URL}}:45700/connect/token

Obs: Caso queira realizar testes no ambiente de Staging/Homologa, utilizar as informações de username, password e syndata desse ambiente e utilizar o link do ambiente de produção para a requisição somente de autenticação.

HEADERS
Content-Type

application/x-www-form-urlencoded

Bodyurlencoded
grant_type

password

Valor Fixo

scope

syngw synpaygw offline_access

Valor Fixo

client_id

synauth

Valor Fixo

client_secret

df956154024a425eb80f1a2fc12fef0c

Valor Fixo

username

{{user}}

Informado pelo cliente - “Suíte / Configurações / Parâmetros” menu “Integração/Mapa”

password

{{password}}

Informado pelo cliente - “Suíte / Configurações / Parâmetros” menu “Integração/Mapa”

syndata

{{token}}

Informado pelo cliente - “Suíte / Configurações / Parâmetros” menu “Integração/Mapa”

POSTAutenticação

{{URL}}:45700/connect/token

Obs: Caso queira realizar testes no ambiente de Staging/Homologa, utilizar as informações de client_id, client_secret e syndata desse ambiente e utilizar o link do ambiente de produção para a requisição somente de autenticação.

HEADERS
Content-Type

application/x-www-form-urlencoded

Bodyurlencoded
grant_type

client_credentials

Valor Fixo

scope

syngw

Valor Fixo

client_id

{{client_id}}

Informado pelo cliente - “Suíte / Configurações / Usuários”, campo "Client Id" do usuário marcado como Integrador

client_secret

{{client_secret}}

Informado pelo cliente - “Suíte / Configurações / Usuários”, campo "Client Secret" do usuário marcado como Integrador

syndata

{{token}}

Informado pelo cliente - “Suíte / Configurações / Parâmetros” menu “Integração/Mapa” ou solicitado a Voalle via protocolo

POSTRefresh Token

{{URL}}:45700/connect/token
HEADERS
Content-Type

application/x-www-form-urlencoded

Bodyurlencoded
grant_type

refresh_token

Valor Fixo

client_id

synauth

Valor Fixo

client_secret

df956154024a425eb80f1a2fc12fef0c

Valor Fixo

refresh_token

Refresh Token

Obtido no método de autenticação

Loading