OpenAPI: como obtenho dados da API de relatórios analíticos, de compras e de sourcing?
Este artigo da base de conhecimentos foi traduzido automaticamente para sua conveniência. A SAP não fornece qualquer garantia em relação à exatidão ou completude da tradução automática. Você pode encontrar o conteúdo original alternando para inglês, usando o seletor de idioma.
Como obtenho dados da API de relatórios analíticos, de compras e de sourcing?
Pré-requisitos:
- Registre-se no portal do desenvolvedor da SAP Ariba onde seus realm(s) residem
- Criar um APP para a API de relatório específica (análise, compras e sourcing)
- Aprovar o APP e ativá-lo no realm específico que você escolher durante o passo 2
- Ter a capacidade de obter a chave secreta (por direito como administrador da organização ou solicitar a chave do administrador da organização)
- Capacidade de gerar a chave secreta para gerar o token de acesso
Resumo do fluxo da API de relatório:
A única forma de gerar dados é usando viewTemplate.
O viewTemplate pode ser um modelo predefinido ou um modelo personalizado que você criou (via API de gerenciamento de modelos).
Os dados de relatório podem ser solicitados como Síncrono (resultado paginado imediato) ou Assíncrono (envio de trabalho - resultado de arquivo compactado).
Detalhes das estruturas da API de relatório:
- Obtenção dos metadados
O ponto de extremidade da API de metadados retornará todos os campos selecionados disponíveis e campos de filtro para documentTypes disponíveis na API de relatórios.
Usando os metadados, os viewTemplate(s) personalizados podem ser criados por meio da visualização Pontos de extremidade da API de gerenciamento de modelos.
Os metadados também devem ser usados para replicar dados, pois consistem em tipo de dados, comprimento e descrição. - Gerenciamento de ViewTemplate
Exibições prontas para uso Modelos são fornecidos e exibições personalizadas Os modelos podem ser criados especificamente para cada documentType.
O requisito para viewTemplate personalizado é documentType, selectFields e filterFields.
Somente 1 documentType pode ser especificado por viewTemplate.
Depois de criado, o viewTemplate personalizado pode ser corrigido, alterando os campos de seleção e os campos de filtro, mas não pode ser alterado para diferentes documentType ou excluído.
Os campos personalizados também devem ser adicionados ao viewTemplate, adicionando os campos personalizados na definição de campos selecionados.
Os modelos não têm campos personalizados, pois são exclusivos de cada realm. Você deve adicionar o(s) campo(s) personalizado(s) à sua visão personalizada Modelo, durante a criação ou corrigindo o viewTemplate. - Obtenção dos dados do relatório
Utilizando viewTemplate, uma chamada síncrona pode ser efetuada para trazer de volta os dados na paginação ou um job assíncrono pode ser enviado e, uma vez concluído, os dados podem ser baixados no formato de arquivo(s) compactado(s).
Glossário:
DocumentType: objeto do banco de dados raiz do cluster. Nos relatórios analíticos, esses são os fatos e as dimensões. Relatórios de suprimento: fatura, entrada, requisição etc. Relatórios de sourcing: tarefa, RFXDocument, organização etc.
viewTemplate: Semelhante à visão de banco de dados, ela consiste em 3 componentes: DocumentType, Select Fields e Filter Fields.
Metadados: preencha os detalhes do(s) documentType(s) disponível(is) juntamente com Selecionar campos e Campos de filtro.
Tarefa de relatório: solicitação assíncrona para obter dados sobre o modelo de visão de relatório específico. O job pode ter vários status (Pendente, Em execução, Concluído e Erro).
Modelo de visão do sistema: modelo de visão genérico, predefinido. Disponível para uso imediato para todos os realms.
Exibição personalizada Modelo: exibição específica Modelo para realm específico, deve ser criado pelo cliente e só está disponível para realm especificado.
Para obter instruções mais detalhadas, no portal do desenvolvedor, clique em Ajuda > Documentação do produto
API de relatório analítico para compras estratégicas e compras operacionais
API de relatórios operacionais para compras da SAP Ariba
API de relatórios operacionais para sourcing da SAP Ariba
Criando relatórios analíticos
Analítico - Referência de fato de relatório
Ariba Connect
Compras
Sourcing estratégico
Spend Visibility
Supplier Information & Performance Management
Supplier Lifecycle & Performance