Cabeçalho padrão de consultas
Atributos padrões
| Nome | Obrigatório | Tipo de dado | Finalidade | Descrição |
|---|---|---|---|---|
| versao | Sim | Texto | Versionamento | Determina a versão do serviço a ser consumido. O retorno pode variar de acordo com o valor do atributo. |
| id_empresa | Sim | Inteiro | Filtro | ID da empresa na qual o serviço irá se basear. |
| token | Sim | Texto | Filtro | Informação única por usuário de acesso. Determina o nível de acesso das informações. |
O cabeçalho padrão de consultas é utilizado como parâmetro único nas chamadas dos serviços. A cada requisição, é dentro do cabeçalho padrão que devemos informar os atributos de versão do serviço, id da empresa a ser acessada e o token de acesso.
- O cabeçalho padrão é um bloco de XML que é passado como parâmetro
- Toda versão de um serviço faz o uso deste cabeçalho
- Determinadas versões aceitam atributos adicionais
Exemplo do parâmetro montado
<servico versao="1.00" token="tkn-vinhasoft-001" id_empresa="1"/>