O que são APIs REST?
Naturalmente, a maioria dos aplicativos e serviços criados e executados na nuvem dependem de APIs REST:
- REST (= transferência de estado representacional)
- é um estilo arquitetônico que define certas diretrizes e restrições sobre como projetar componentes na web. Em particular, enfatiza a interação e a comunicação de tais componentes.
- APIs (= Application Programming Interfaces)
- define como os componentes podem ser contatados por outros componentes para acionar determinadas funcionalidades ou dados de intercâmbio.
Uma API REST (também RESTful API) é uma API que adere às diretrizes e restrições definidas pelo estilo de arquitetura REST.
Os usuários finais geralmente não acessam as APIs REST de aplicativos e serviços em nuvem diretamente. Eles usam principalmente um aplicativo que fornece uma interface gráfica de usuário (GUI) e compõe informações relevantes de outros aplicativos e componentes na nuvem, usando APIs REST. Assim, as APIs REST são ocultadas do usuário final. Mas isso pode ser diferente para desenvolvedores ou administradores, pois eles podem querer usar ou testar funcionalidades que não são fornecidas por um aplicativo com GUI.
Durante o processo de desenvolvimento, o desenvolvedor pode precisar testar ou simular funcionalidades individuais de determinados componentes, independentemente de outros componentes relevantes para o sistema ou arquitetura geral. Por exemplo, o desenvolvedor está trabalhando em um novo processo para a aprovação de solicitações de ausência. No cenário produtivo, o processo deve ser acionado por uma aplicação que é desenvolvida por outra equipe. O aplicativo chamará uma API REST do SAP Build Process Automation para acionar o processo de aprovação de ausência. Uma vez que a aplicação ainda não existe, o desenvolvedor quer acionar a API REST manualmente durante o processo de desenvolvimento para teste. Para isso, eles podem usar um chamado cliente REST.
Um mandante REST é uma ferramenta que simplifica a comunicação técnica com APIs REST. Ele fornece uma interface para protocolos de comunicação técnica necessários, como HTTPS, e facilita o seu uso.
Outra função que pode estar interessada em clientes REST no contexto do SAP Build Process Automation é o operador ou administrador. Essa função administra, processa e pode precisar executar tarefas irregulares de vez em quando. Estas podem ser, por exemplo, tarefas de depuração. Muitas funções de administração e operação do SAP Build Process Automation estão disponíveis nos apps "Monitorar instâncias de processo e workflow" e "Administrar processos e workflows", mas algumas funções só podem estar disponíveis por meio da respectiva API REST.
Descobrindo APIs do SAP Build Process Automations no SAP Business Accelerator Hub
Ao inserir o SAP API Business Hub (link a ser substituído em breve) e procurar o produto SAP Build Process Automation, você encontrará o pacote de API correspondente. Em seguida, você encontra as diferentes APIs que ele contém e um exemplo de como essas APIs podem ser aproveitadas.
- Execução de automação
- Crie um aplicativo que permita iniciar automações específicas clicando em um botão.
- Monitoramento de automação
- Recupere os logs de execuções de automação anteriores e administre-os em outra ferramenta.
- Decisões
- Execute um serviço de regras utilizando um mandante REST para testar se ele gera os resultados previstos.
- Caixa de entrada
- Crie uma aplicação de caixa de entrada personalizada que tenha uma aparência diferente da aplicação padrão Minha caixa de entrada fornecida pela SAP. Esse caso de uso também exigiria a API Processos e fluxos de trabalho.
- Fluxos de trabalho
- Permitir que outra aplicação acione novas instâncias de processo ou workflow.
- Cenários de visibilidade
- Obtenha visibilidade de processos ou fluxos de trabalho em sistemas de terceiros, enviando eventos de processo para o serviço SAP Build Process Automation.
- Espaço de trabalho de visibilidade
- Obtenha uma síntese dos cenários de visibilidade aos quais um usuário específico tem acesso.
Localizando um ponto de acesso a ser usado
Digamos que você queira descobrir como acionar um novo processo ou instância de workflow usando as APIs do SAP Build Process Automation.
No pacote API SAP Build Process Automation, selecione a API REST Workflows. Você obterá uma síntese e descrição da API REST.
Selecione Referência de API para ver detalhes dos diferentes pontos de acesso de API que ele fornece.
Selecione Instâncias de workflow e, em seguida, o ponto de acesso POST para iniciar novas instâncias.
Agora você pode ver os detalhes para o respectivo ponto de acesso. Esta visão é especialmente importante porque também fornece detalhes sobre funções ou escopos necessários para executar o API e sobre parâmetros que são necessários ao chamar a API. No exercício a seguir, você aprenderá sobre as etapas exatas necessárias ao usar uma API do SAP Build Process Automation.
