Alguns pré-requisitos são necessários para o processo de envio de mensagens. As informações abaixo são cadastradas em tempo de setup de uma embarcadora e para que o embarcador possa operar, é necessário informa-las nas requisições, pois serão validadas para identificar o embarcador e o processo a ser executado.
1.EnterpriseId: Cada Embarcadora terá um identificador do tipo GUID (Global Unique Identifier). Este identificador determinará o emitente da mensagem. Está informação será gerada pela Localização no momento da implantação e deve ser informada nas requisições enviadas à Localização.
2.DestinationId: Esta informação é utilizada para a troca de mensagens entre empresas e não se aplica ao cenário de embarcadores. Este campo deve ser preenchido com o mesmo valor do elemento ‘EnterpriseId’, o qual deve ser verificado após a implantação (conforme mencionado no referido elemento). Este campo é opcional e pode não ser informado.
3.Token: GUID que correlaciona o emitente ao destinatário da mensagem. Esta correlação é obrigatória como garantia de que o emitente e o destinatário possuem um elo entre eles, este será gerado pela Localização no momento da implantação, e disponibilizado para a Embarcadora;
4.ProcessCode: Identifica o processo que irá recepcionar a mensagem, cada processo terá um código único (ex.: envio de embarque = 25000, envio de NF-e = 25400, etc) os códigos que devem ser utilizados estão disponíveis em cada tópico a seguir;
5.MessageType: Identifica o tipo da mensagem que esta sendo enviada, cada ação possui um código único, (ex. 100 = insere informações ou documentos, 103 = Solicitações de download ou status de processamento, etc).
6.ExchangePattern: Identifica qual a ação que a mensagem terá no curso de sua execução, cada ação possui um código único; (ex.: envio de requisição = 7, pesquisa resultado requisição = 8).
7. Guid: Toda mensagem trocada entre Localização e Embarcadora via WebService tera um GUID (Global Unique Identifier) identificando esta mensagem, o envio deste não é obrigatório pela Embarcadora, visto que se não for informado no envio da mensagem, a Localização irá gerar um automaticamente e informar no retorno da solicitação.
Em toda chamada Web Service serão analisadas as três primeiras informações (EnterpriseId, DestinationId e Token) para garantir a correta conectividade entre emissor e destinatário.
O ProcessCode e o MessageType identificam qual a fila de processamento que a mensagem será enviada. Sendo assim, se estas informações não existirem será retornada uma mensagem de erro na chamada do Web Service.