Instruções Iniciais
Antes de tudo, é necessário compreender alguns conceitos que serão vistos frequentemente neste manual, segue abaixo.
Posto Avançado de Serviço (PAS):
Cada usuário do sistema pode ser vinculado a um ou mais PAS’s, de acordo com a necessidade. Um PAS também está relacionado a um ou mais clientes, conforme for necessário. Uma empresa pode utilizar um PAS para cada filial, ou então operar com apenas um PAS que englobe todos os seus clientes. O usuário, entretanto, só consegue gerar uma AE para um cliente que esteja vinculado ao PAS selecionado.
Ex.: Um usuário realiza operações para um embarcador e duas transportadoras. Então, ele pode ser adicionado a apenas um PAS, que reúne os três clientes, ou estar vinculado a até três PAS’s distintos.
Chave de Acesso:
É uma string gerada no início da conexão com o Web Service, pela execução do método sgrLogin. Contendo as informações do usuário conectado, como o seu login e seu PAS, a validação dessa chave garante a segurança dos dados.
sgrData:
O retorno dos métodos será sempre no formato sgrData, que é um objeto composto das seguintes propriedades:
ReturnDataset: retorna um dataset com os dados solicitados;
ReturnDescription: guarda as mensagens dos possíveis erros retornados pelos métodos;
ReturnID: guarda o código dos possíveis erros retornados pelos métodos;
ReturnKey: armazena a chave de acesso retornada pelo método e utilizada nos demais métodos.
Entendendo esses termos, é preciso reforçar a necessidade de se ter a certeza dos serviços contratados. Isso porque, como explicado anteriormente, os métodos a serem utilizados variam conforme o serviço contratado. Portanto, é recomendado solicitar ao gerente de contas uma explicação detalhada sobre as regras, produtos e valores que foram configurados.