
O SAP Field Service Management expõe várias APIs (Application Programming Interfaces) que oferecem várias formas de acessar os dados e as funcionalidades do Field Service Management a partir de sistemas externos. Essas APIs são usadas pelo próprio Field Service Management ou podem ser aproveitadas para suportar integrações e aprimoramentos personalizados.
As APIs FSM fornecidas incluem o seguinte:
- API de consulta: para consultar dados armazenados no SAP Field Service Management Cloud.
- API de dados: fornece acesso total aos dados armazenados no SAP Field Service Management Cloud.
- API em massa: uma extensão da API de dados v4 usada para criar/atualizar e excluir recursos em massa.
- API de serviço: para criar, atualizar e processar chamadas de serviço e atividades no FSM.
- API de relatório: fornece recursos de relatório expostos como um conjunto de serviços da Web, com base em um mecanismo Jasper Reports.
- Melhor API de técnico correspondente: para encontrar automaticamente o melhor técnico correspondente para uma atividade.
- API de reserva de ocupação de portões: para ajudar a encontrar técnicos e horários de compromisso adequados para atividades.
- API de reotimização: para reprogramar de forma assíncrona os trabalhos atribuídos de maneira autônoma e otimizada.
- Crowd Partner API: para convidar subcontratados para se juntarem à plataforma SAP Field Service Management Crowd.
- Crowd Technician API: para criar e gerenciar os técnicos do Crowd que aceitam atribuições e concluem o trabalho como parte da plataforma SAP Field Service Management Crowd.
- Crowd Partner Dispatching API: para fazer solicitações de um aplicativo de terceiros para o SAP Field Service Management, para gerenciar atividades atribuídas a um parceiro Crowd.
- API de acesso: para permitir que os aplicativos obtenham acesso limitado ao SAP Field Service Management.
- API de usuário: para criar e gerenciar registros de usuários e direitos de acesso do usuário para aplicativos SAP Field Service Management.
- API SCIM: baseada no System for Cross-domain Identity Management (SCIM), que é um padrão aberto para automatizar a troca de dados do usuário entre diferentes domínios de identidade de usuário.
Todas as APIs FSM utilizam o protocolo HTTP e aplicam o paradigma Representational State Transfer (REST). Uma compreensão básica desses conceitos é necessária para usá-los.
Para consumir as APIs, é recomendável usar uma ferramenta especializada que forneça assistência para testes de API, como Postman ou Insomnia. Como alternativa, uma ferramenta de linha de comando pode ser usada.
Todas as interações são baseadas em solicitações enviadas do sistema client que são depois processadas pelo sistema do servidor (neste caso, FSM). Após o processamento da solicitação, o servidor envia uma resposta com o resultado, por exemplo, o conteúdo do recurso que foi consultado.
As solicitações e respostas contêm recursos que são trocados entre o servidor e o cliente. Um recurso é uma informação que representa uma entidade no contexto da API específica. O cliente pode consultar um recurso no servidor, mas também enviar recursos para criá-los ou atualizá-los no lado do servidor. Em ambos os casos, o servidor incluirá os recursos processados em sua resposta.
A chave para interagir adequadamente com as APIs do FSM Cloud está na composição de solicitações HTTP válidas que podem ser processadas pela API específica. A estrutura de uma requisição HTTP consiste em três partes distintas:
- Linha de solicitação
- Campos de cabeçalho
- Corpo da mensagem
Embora o corpo da mensagem seja específico de cada API, os campos de linha e de cabeçalho da solicitação compartilham várias características comuns na maioria das APIs FSM.
