Comportamento da API

Cada API assume um documento XML como entrada e retorna um outro documento XML como saída. APIs podem ser assíncronas ou síncronas.

O parâmetro de entrada YFSEnvironment representa um estado de tempo de execução sob o qual esta API está sendo chamada. Ele é usado para as tarefas a seguir:

Auditorias de segurança e criação de log
Controle de transação
Atingir o comportamento da API específica da chamada

Para um serviço assíncrono, o IBM® Sterling™ Order Management System cria automaticamente uma instância desse objeto e a transmite para cada parte da API do serviço. Para chamar programaticamente um serviço síncrono, é necessário criar uma instância deste ambiente chamando a API createEnvironment().

Nota: em geral, a entrada para APIs não deve conter elementos ou atributos "BLANK". Um elemento em branco pode ser definido como um elemento contendo todos os atributos com valores em branco. Se um elemento em branco for transmitido, o comportamento da API será imprevisível.

Todas as APIs (sejam padrão ou estendidas) possuem a mesma assinatura com relação aos parâmetros de entrada e aos valores de retorno. Esta assinatura é do formulário

org.w3c.dom.Document APIName(YFSEnvironment env, org.w3c.dom.Document input);

Para que APIs customizadas acessem valores customizados, a API deve implementar a interface com.yantra.interop.japi.YIFCustomApi. Se inseridos, estes pares nome/valor são transmitidos para a API Customizada como um objeto de Propriedades. Para obter mais informações sobre a interface do com.yantra.interop.japi.YIFCustomApi , consulte o Javadoc