Configuração da API OData no Jitterbit API Manager

Introdução

Esta página descreve como criar e configurar uma API OData a partir da página de APIs do Jitterbit API Manager. Uma API OData é um dos três tipos de APIs configurados através do API Manager. Para os outros dois tipos, API personalizada e API proxy, consulte a configuração de API personalizada e a configuração de API proxy.

APIs OData (publicadas e em rascunho) são exibidas nestes locais:

• A página de APIs do API Manager.
• A aba Recursos do painel do projeto para o projeto do Design Studio associado à API OData.

Pré-requisitos

Uma API OData expõe uma operação de entidade API do Jitterbit iPaaS para consumo. Você deve primeiro criar e implantar essa operação antes de poder configurar a API OData. A operação que uma API OData aciona deve ser uma operação de entidade API do Design Studio.

Para informações sobre como criar e implantar uma operação de entidade API no Design Studio, consulte estes recursos:

• Guia de início rápido do Design Studio
• Criar uma entidade Jitterbit
• Criar uma operação de entidade API

Criar uma nova API OData

Quando você acessa a página de APIs do API Manager, se não existirem APIs personalizadas, APIs OData ou APIs proxy na organização selecionada, esta tela estará em branco.

Para criar uma nova API OData, clique em Novo > API OData.

Configurar uma API OData

A tela de configuração inclui várias abas, com duas abas obrigatórias e três abas opcionais. Cada aba é abordada nas seções a seguir:

• Aba de Perfil (obrigatória)
• Aba de Configurações (opcional)
• Aba de Serviços (obrigatória)
• Aba de Perfis de Segurança (opcional)
• Aba de Papéis de Usuário (opcional)

Aba de Perfil

Use a aba Perfil para inserir informações básicas que identificam a API.

Configure as seguintes configurações:

• Nome da API: Insira um nome para a API a ser usado para fins de identificação interna. Os seguintes caracteres especiais são permitidos: ( ) - _.

• Raiz do Serviço: O nome público da API a ser usado como parte da URL do serviço da API. Por padrão, este campo é preenchido com o Nome da API convertido para camel case. Este campo não permite espaços ou certos caracteres especiais. O uso de caracteres especiais além de um sublinhado (_) não é recomendado. Os seguintes caracteres especiais são permitidos: . _ ~ ( ) $ ; / ? : @ = & ' ! * , + -.

• Descrição: Insira uma descrição opcional para a API.

• Ambiente: Use o menu para selecionar o ambiente onde a API residirá. Você pode digitar qualquer parte do nome do ambiente no menu para filtrar a lista de ambientes. Os resultados do menu são filtrados em tempo real a cada tecla pressionada.

  Nota

  Após a criação da API, você não pode mudar o ambiente. Para mover uma API entre ambientes, você pode clonar a API ou exportar e importar a API em outro ambiente.

• Número da versão: Insira uma versão opcional para usar como parte da URL de serviço da API. Este campo permite um máximo de 48 caracteres e não permite espaços ou certos caracteres especiais. O uso de caracteres especiais além de um ponto (.) ou um hífen (-) não é recomendado. Convenções comuns de nomenclatura incluem versões incrementais como v1.0, v1.1, v1.2, ou usar uma data em que a API foi publicada, como 2025-08-28.

Após completar a aba Perfil, clique em Próximo para prosseguir para a aba Configurações, ou clique em Salvar como rascunho para salvar seu progresso.

Aba Configurações

A aba Configurações é opcional e contém opções de configuração avançadas para a API.

Configure as seguintes configurações conforme necessário:

• Tempo limite: Insira o número de segundos antes que a API atinja o tempo limite. O padrão é 30 segundos. O valor máximo permitido é 180 segundos.

  Nota

  Esta configuração é independente da configuração de tempo limite de operação em Studio ou Design Studio. As configurações de tempo limite de operação não são utilizadas a menos que um agente privado seja usado e a configuração EnableAPITimeout no arquivo de configuração do agente privado esteja habilitada.

• Apenas SSL: Este interruptor está habilitado por padrão e requer HTTPS para a API. Quando habilitado, os dados são criptografados através de SSL, e uma solicitação HTTP retorna um erro. Quando desabilitado, tanto solicitações HTTP quanto HTTPS são suportadas.

  Aviso

  Quando desativado, os dados transmitidos por meio de solicitações e respostas da API não são criptografados e podem ser interceptados e visualizados por outros. Isso pode potencialmente expor informações sensíveis.

• CORS: Ative este botão para suportar CORS (Compartilhamento de Recursos entre Diferentes Origens). CORS é um mecanismo que permite que aplicativos da web executando em um navegador em um domínio acessem recursos de um servidor em um domínio diferente.

  Aviso

  Ativar CORS faz com que operações usando o método OPTIONS sejam executadas sem autenticação.

• Registro detalhado: Ative este botão para registrar cabeçalhos de solicitação e cargas úteis quando uma solicitação de API for feita.

  Aviso

  O registro detalhado pode incluir dados sensíveis, como credenciais de autenticação ou informações pessoalmente identificáveis. Use esta configuração com cuidado.

• Ativar modo de depuração até: Ative este botão para ativar o registro detalhado para solução de problemas, em seguida, clique no ícone de calendário para selecionar uma data de até duas semanas a partir de hoje, quando o modo de depuração será desativado automaticamente. Quando você ativa o modo de depuração para operações acionadas por esta API, os registros da API incluem dados de solicitação e resposta (mantidos por 30 dias) que você pode acessar através da página Runtime do Console de Gerenciamento. Por padrão, o Gerenciador de API registra apenas operações de API com erros.

  Aviso

  Os registros de depuração contêm todos os dados de solicitação e resposta, incluindo informações sensíveis, como senhas e informações pessoalmente identificáveis (PII). Esses dados aparecem em texto claro nos registros da nuvem Harmony por 30 dias.

Após configurar a aba Configurações, clique em Próximo para prosseguir para a aba Serviços, ou clique em Anterior para retornar à aba Perfil.

Aba Serviços

A aba Serviços é onde você configura os serviços da API que definem como a API responde às solicitações. Para APIs OData, você atribui operações de entidade Jitterbit que expõem dados por meio do protocolo OData.

Clique em Novo Serviço para adicionar um novo serviço de API. Configure as seguintes definições para cada serviço:

• Entidade: Selecione entre os projetos implantados que contêm uma operação de entidade API no ambiente onde você está configurando a API. O nome da entidade corresponde ao nome do projeto no Design Studio.

• Projeto: Exibe o nome do projeto do Design Studio que contém a entidade selecionada.

• Operação: Selecione entre as operações de entidade API implantadas no Design Studio na entidade selecionada. Apenas uma operação usando cada método pode ser atribuída.

  Importante

  Por padrão, operações bem-sucedidas configuradas para uma API OData não estão incluídas nos logs de operação a menos que uma dessas configurações esteja habilitada:

  • Agentes em nuvem: Para operações de API em um agente em nuvem, o registro de depuração de operação deve estar habilitado na operação.
  • Agentes privados: Para operações de API em um agente privado, ou o registro de depuração de operação deve estar habilitado na operação ou você deve definir EnableLogging=true na seção [APIOperation] do arquivo de configuração do agente privado.

  Operações malsucedidas estão incluídas nos logs de operação independentemente de as configurações acima estarem habilitadas ou não.

• Método: Selecione o método HTTP a ser criado para a operação selecionada. Os métodos disponíveis incluem GET, PUT, POST, DELETE, PATCH, MERGE ou ALL. Selecionar ALL cria métodos separados GET, PUT, POST, DELETE, PATCH e MERGE para a operação selecionada. Para usar um método não listado, insira o nome do método na caixa de texto Digite um novo método e pressione Enter.

• Ações: Passe o mouse sobre uma linha de serviço para revelar ações adicionais.

  • Copiar URL do serviço API: Clique para copiar o URL do serviço da API.
  • Ir para o Serviço API: Clique para ver uma visão geral em uma única página da configuração da API OData.
  • Duplicar: Clique para duplicar o serviço da API.
  • Excluir: Clique para excluir o serviço da API.

Você pode configurar vários serviços para uma única API OData. É necessário adicionar pelo menos uma entidade para prosseguir para a próxima aba.

Após configurar a aba Serviços, clique em Próximo para prosseguir para a aba de Perfis de Segurança, ou clique em Anterior para retornar à aba de Configurações.

Aba de Perfis de Segurança

A aba Perfis de Segurança é opcional e permite restringir o acesso para consumo da API.

Configure as seguintes configurações:

• Atribuir: Use o botão para atribuir ou desatribuir perfis de segurança para a API.

• Nome do Perfil: O nome do perfil de segurança conforme configurado em Perfis de Segurança.

• Tipo: O tipo de autenticação para o perfil de segurança, como Básico, OAuth 2.0 ou Chave da API.

• Nome de Usuário: Para autenticação básica, isso exibe o nome de usuário. Para outros tipos de autenticação, isso exibe o mesmo valor que a coluna Tipo.

• Ações: Passe o mouse sobre uma linha de perfil de segurança para revelar ações adicionais.

  • Ir para perfil de segurança: Clique para abrir a configuração do perfil de segurança.

Dependendo das políticas da organização Harmony, pode ser necessário atribuir um perfil de segurança para salvar a API.

Clique em Novo perfil de segurança para criar um novo perfil de segurança. Para instruções, veja Configurar perfis de segurança.

Após configurar a aba Perfis de Segurança, clique em Próximo para prosseguir para a aba Funções de Usuário, ou clique em Anterior para retornar à aba Serviços.

Aba Funções de Usuário

A aba Funções de Usuário é opcional e determina quais funções da organização têm acesso à API dentro do Gerenciador de API.

Configure as seguintes configurações:

• Função de Usuário: O nome da função da organização conforme definido na aba Funções da página de Gerenciamento de Usuários.

• Permissões: As permissões atribuídas a essa função, como Ler ou Admin.

• Status: Indica se a função está atribuída a esta API. Altere o status para atribuir ou desatribuir funções.

• Ações: Passe o mouse sobre uma linha de função de usuário para revelar ações adicionais.

  • Ir para função de usuário: Clique para abrir a configuração da função de usuário.

As funções que você seleciona aqui determinam o acesso a esta API específica a partir destas páginas:

• APIs
• Gerenciador de Portal, incluindo a geração de documentação da API
• Portal da API
• Logs da API
• Análises

O acesso à página Perfis de Segurança e o acesso para consumir a API não são afetados por esta seleção. O acesso para consumir uma API é controlado por perfis de segurança.

Qualquer função de usuário definida com a permissão Admin sempre terá acesso total a todas as APIs e, portanto, não pode ser removida da seleção.

Clique em Novo papel de usuário para criar um novo papel de usuário. Para instruções, veja Papéis em Gerenciamento de Usuários.

Depois de configurar a aba Papéis de Usuário, clique em Publicar para publicar a API ou clique em Salvar como rascunho para salvar seu progresso.

Opções de salvar e publicar

Depois de configurar todas as abas necessárias, você pode salvar ou publicar a API:

• Salvar como rascunho: Salva a API no status Rascunho ou Publicado com Rascunho. APIs em rascunho não contam contra seu limite de assinatura de URL da API. Uma API cujo status era Publicado no momento em que você usa Salvar como rascunho é salva como Publicado com Rascunho. Uma API publicada conta contra seu limite de assinatura de URL da API, mesmo que seu rascunho não esteja acessível.

• Publicar: Salva a API no status Publicado. A API está ao vivo e acessível em cinco minutos. Uma API publicada conta contra seu limite de assinatura de URL da API. Um diálogo indica que a API está ao vivo:

  

  O diálogo fornece estas opções:

  • Copiar URL: Copia o URL do serviço da API para sua área de transferência.
  • Gerar Documento OpenAPI: Abre a página Gerenciador do Portal. Observe que você pode gerar documentação OpenAPI apenas para APIs personalizadas, não para APIs OData.
  • Fechar: Fecha o diálogo.

Parâmetros de consulta OData

Você pode filtrar os dados retornados anexando parâmetros de consulta OData a uma URL de serviço da API OData. Os parâmetros de consulta específicos suportados dependem do banco de dados subjacente.

Os parâmetros de consulta OData comuns incluem:

https://jbexample.jitterbit.net/Sandbox/customers?$top=10&$orderby=name

Editar a API

Após salvar a API, você pode editá-la a partir destes locais:

• Usando visualização em bloco na página de APIs, clique em Visualizar/Editar.
• Usando visualização em lista na página de APIs, clique em Editar na coluna Ações.