Sterling Order Management Sistema do Sterling Order Management

As APIs do Sterling™ Order Management System são fornecidas imediatamente para que a maioria das entidades comerciais do Sterling Order Management System realize operações de leitura. É possível procurar dados, listar dados ou obter informações detalhadas relacionadas à entidade do banco de dados em nuvem chamando essas APIs. Os aplicativos do Sterling Order Management System também estão usando essas APIs para publicar dados em suas próprias UIs As mesmas APIs podem ser chamadas a partir de testadores de XAPI e de API REST que estão disponíveis prontos para uso ou de uma IU customizada ou de um cliente REST de 3^terceiros também. Para chamar as APIs, deve-se fornecer as credenciais de login para autenticar o usuário. Os testadores de API capturam essas informações junto com a entrada da API. Considerando que, as UIs do Sterling Order Management System enviam as credenciais do usuário com login efetuado junto com a solicitação. O back-end do Sterling Order Management System autentica o usuário primeiro e, em seguida, inicia com o processo de solicitação da API (interface de programação de aplicativos)

O comportamento da API e as especificações de entrada / saída XML são fornecidos no Javadoc Sterling Order Management System . Visualizar <runtime>/xapidocs/api_javadocs/index.html para obter detalhes. Da mesma forma, consulte a página <runtime>/xapidocs/restdoc/index.html para obter recursos URL REST e especificações de entrada ou saída.

A abordagem XML suporta consultas complexas com expressões AND ou OR e correspondência de consulta avançada como 'Contains’,'Starts with', Only Null e assim por diante e os operadores relacionais. Na abordagem REST, consultas complexas não são suportadas na solicitação GET , mas também é possível fazer uma solicitação POST com um ou mais critérios complexos.

As solicitações de API são processadas de forma síncrona na JVM do servidor de aplicativos e as respostas são enviadas de volta para o navegador Se você estiver chamando uma API com um critério vazio ou passando alguns critérios que podem buscar um grande volume de dados, poderá sufocar o tráfego de rede e, às vezes, até travar o servidor de aplicativos. Portanto, a IBM recomenda fortemente que os usuários detenham tais situações e aconselha a inserir critérios mais específicos e recuperar apenas os dados relevantes.

Uma solução para isso é usar a Paginação Há muitas APIs do Sterling Order Management System que suportam paginação e você é aconselhado a chamar essas APIs com Paginação. Leia o Javadoc da API Sterling Order Management System para saber se uma API suporta paginação ou não. Quase todas as APIs são controladas por modelo e é muito importante especificar um modelo ajustado com os atributos necessários, ao recuperar um enorme volume de dados.. Em todos os casos, é melhor obter uma contagem de registros primeiro para avaliar o quantum de dados e, em seguida, executar APIs no modo paginado ou tornar os critérios de entrada mais específicos. Todas as APIs de lista podem ser chamadas para 'count', especificando um modelo de saída com o atributo TotalNumberOfRecords apenas.

Ambos os testadores de API não estão disponíveis no ambiente de produção Portanto, é aconselhável fazer chamadas REST a partir de sua UI customizada ou de um cliente REST de 3^terceiros com credenciais de autenticação de suporte. Poucos clientes REST de^terceiros suportam o download das respostas também É melhor fazer download e analisar quando os resultados são bastante altos.

Tabela 1. APIs REST de amostra
Padrão de API.	Exemplo de URL REST
`getOrderList` -entrada vazia	RECEBER `https://<ip>:<port>/smcfs/restapi/order`
`getOrderList` -com parâmetros de entrada	RECEBER `https://<ip>:<port>/smcfs/restapi/order?EnterpriseCode=~eq~Matrix&DocumentType=~eq~0001`
`getOrderList` -com parâmetros de entrada e ordem por vendedores	RECEBER `https://<ip>:<port>/smcfs/restapi/order?EnterpriseCode=~eq~Matrix&DocumentType=~eq~0001 &sort(+SellerOrganizationCode)`
`getOrderList` -com parâmetros de entrada, ordem por vendedores, paginate (obter primeiro 100)	RECEBER `https://<ip>:<port>/smcfs/restapi/order?EnterpriseCode=~eq~Matrix&DocumentType=~eq~0001 &sort(+SellerOrganizationCode)&_range=0-99`
`getOrderList` -com parâmetros de entrada, ordem por vendedores, paginado e com um modelo de saída	RECEBER `https://<ip>:<port>/smcfs/restapi/order?EnterpriseCode=~eq~Matrix&DocumentType=~eq~0001 &sort(+SellerOrganizationCode)&_range=0-99&_templateKey=api_tpl_1`
`GetOrderLinesData` -um serviço customizado	POSTAR `https://<ip>:<port>/smcfs/executeFlow/GetOrderLinesData Body: input in JSON format`

Os modelos de API fornecidos pelo usuário podem ser criados no banco de dados chamando a API manageApiTemplate . Isso pode ser chamado no ambiente de configuração principal (inferior) dos testadores de API e obter essa configuração para o banco de dados de produção usando a CDT ou os usuários podem fazer outra chamada REST para essa API para inserir o modelo no banco de dados. Por exemplo, api_tpl_1, no URL de amostra fornecido, é o identificador de um modelo para a API getOrderList, criado no banco de dados antes de fazer essa chamada.