Crie uma API personalizada simples no Jitterbit API Manager
Introdução
Esta página é destinada a novos usuários do API Manager e demonstra como criar e publicar manualmente uma API personalizada usando um Integration Studio operação.
Para criar e publicar uma API por meio de um diálogo escrito interativo com um chatbot de IA, consulte Jitterbit AI Bot (Beta) para Jitterbit API Manager.
Para um guia abrangente e passo a passo, inscreva-se em Criação e gerenciamento de API curso na Universidade Jitterbit.
Para obter informações sobre a configuração de um tipo específico de API, consulte estes recursos:
Pré-requisitos
Antes de criar uma API personalizada, você deve ser membro de uma organização Harmony com uma assinatura do API Manager e deve ter as permissões de organização e os níveis de acesso ao ambiente apropriados, conforme descrito em Permissões e acesso do Harmony.
Crie uma API com o API Manager
Siga estas etapas para criar uma API personalizada com o API Manager:
Etapa 1: criar e implantar a operação
Conforme descrito em Pré-requisitos da API customizada, um Integration Studio ou Design Studio a operação deve primeiro ser criada e implantada no mesmo ambiente em que você deseja criar uma API personalizada.
Nesta Integration Studio Por exemplo, a operação implantada consulta um banco de dados e processa os dados em uma saída CSV:
Para obter instruções sobre como criar e implantar uma operação em Integration Studio ou Design Studio, veja estes recursos:
- Integration Studio
- Design Studio
Etapa 2: Configurar a API
Uma vez que o Integration Studio ou a operação do Design Studio foi implantada, navegue até a página de APIs no API Manager e clique em Novo > API customizada:
Ao clicar em API customizada, a tela de configuração API Settings abre. Preencha cada campo com estas configurações:
Depois que os campos acima forem preenchidos, clique em Avançar.
Nota
Para obter informações sobre cada campo nesta tela de configuração, consulte Etapa 1: Configurações em Configuração de API customizada.
Como uma API personalizada está sendo criada, API customizada foi selecionada como o Tipo de serviço. O Integration Studio operação de Etapa 1: Criar e implantar a operação é atribuído ao serviço GET API:
Depois que os campos acima forem preenchidos e a operação atribuída, clique em Salvar e depois em Avançar.
Nota
A operação usada para o propósito deste guia tem uma atividade de resposta da API configurado como o alvo da operação (consulte Etapa 1: Criar e implantar a operação). Como resultado, o Tipo de resposta é definido como Destino final.
Para obter mais informações sobre os campos Projetos, Operação, Método e Tipo de resposta, consulte Etapa 2: Selecionar tipo de serviço e atribuir operações em Configuração de API customizada.
Na próxima tela, funções de usuário e um ou mais perfis de segurança apropriados são atribuídos à API personalizada:
As funções a serem escolhidas são aquelas definidas na aba Funções da página Gerenciamento de usuários.
Para obter mais informações sobre como atribuir funções de usuário, consulte Etapa 3: Atribuir funções de usuário e perfis de segurança em Configuração de API customizada.
Para obter mais informações sobre perfis de segurança, consulte estes recursos:
Ao clicar em Avançar, você chegará à página Resumo e Confirmação:
Ao clicar em Salvar e Publicar, uma caixa de diálogo indica que a API está ativa:
Clique em Copiar URL. A URL copiada será usada em Etapa 3: Testar a API.
Etapa 3: Teste a API
Para testar a API, cole a URL da API de Etapa 2: Configurar a API em um navegador da web:
Uma vez autenticado, o Integration Studio operação de Etapa 1: Criar e implantar a operação é acionado e responde com uma saída CSV da lista de clientes da empresa de exemplo:
Próximos passos
Depois que a API estiver ativa, você poderá gerenciá API gerando documentação da API no Gerenciador do Portal página, visualizando os logs na API Logs página ou revisar as métricas de consumo e desempenho da API na Analytics página.
Para obter informações adicionais sobre o API Manager, consulte estes recursos: