Publicar uma operação como uma API no Jitterbit Studio
Introdução
Esta página descreve como configurar e publicar uma API personalizada (para expor uma operação para consumo) no Studio. A opção Publicar como uma API está acessível no menu de ações de uma operação.
Como alternativa, é possível criar APIs personalizadas no API Manager usando a interface ou o Assistente de IA.
Para um guia orientado por tarefas sobre como publicar uma operação como uma API REST, incluindo configuração de resposta e segurança, consulte Expor uma operação do Studio como uma API REST.
Nota
Após publicada, uma API personalizada conta como uma URL de API em relação ao limite de sua assinatura Harmony.
APIs personalizadas (publicadas e rascunhos) são exibidas nestes locais:
- A página APIs do API Manager.
- A aba Recursos do painel de projetos para o projeto do Studio associado à API personalizada.
Pré-requisitos
Para usar a opção Publicar como uma API no menu de ações da operação, estes pré-requisitos devem ser atendidos:
-
A organização sendo acessada deve ter uma assinatura do API Manager e ter as permissões de função e níveis de acesso ao ambiente apropriados. Para informações sobre como adicionar API Manager à sua licença, entre em contato com seu Customer Success Manager (CSM).
-
A operação não deve ter alterações não implantadas.
Configurar a API
Após clicar na opção Publicar como uma API no menu de ações da operação, uma gaveta de configuração de API é aberta na parte inferior do designer de projetos. As cinco etapas do processo de configuração estão descritas abaixo:
Perfil

Digite as seguintes informações básicas sobre a API.
Nota
Configurações opcionais como parâmetros de caminho, parâmetros de consulta e cabeçalhos de solicitação podem ser definidos no API Manager (consulte a aba Serviços em API Personalizada).
-
Nome da API: Digite um nome para a API a ser usado para fins de identificação interna.
-
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 operação convertido para camelCase. Este campo não permite espaços ou certos caracteres especiais. Não é recomendado usar caracteres especiais diferentes de um sublinhado (
_). Estes caracteres especiais são permitidos:_~()$;/\?:@=&'!*@,+- -
Descrição: Digite uma descrição opcional para a API.
-
Ambiente: Este campo é definido como o ambiente do projeto atualmente em acesso e não pode ser alterado.
-
Número da versão: Digite uma versão opcional a ser usada como parte da URL do serviço da API. Este campo permite um máximo de 50 caracteres e não permite espaços ou certos caracteres especiais. Não é recomendado usar caracteres especiais diferentes de um ponto (
.) ou um hífen (-). As convenções de nomenclatura comuns incluem versões incrementadas, comov1.0,v1.1,v1.2, ou usar uma data em que a API foi publicada, como2023-09-21.
Configurações
Continue configurando a API. Essas configurações são opcionais.

-
Timeout: Digite o número de segundos antes da API expirar. O padrão é
30segundos. O máximo é180segundos.Nota
Essa configuração é independente da configuração Operation time out disponível na aba Opções da operação. As configurações de timeout da operação não são usadas para APIs do API Manager, a menos que um agente privado seja usado e a configuração
EnableAPITimeoutno arquivo de configuração do agente privado esteja ativada. -
SSL only: Essa opção está ativada por padrão e exige o uso de criptografia SSL (recomendado).
-
CORS: Ative para habilitar Cross-Origin Resource Sharing (CORS) (não recomendado). Ativar esse botão exibe a seguinte mensagem:
Texto do diálogo
Habilitar CORS
Permitir que qualquer origem acesse uma API não é recomendado devido a possíveis riscos de segurança. Uma preocupação importante é que isso faz com que a operação atribuída ao método OPTIONS seja executada sem autenticação. Antes de habilitar essa configuração, confirme se está alinhada com as políticas de segurança da sua organização.Para mais informações, consulte Cross-Origin Resource Sharing na MDN.
ContinuarCancelar -
Verbose logging: Ative para habilitar o verbose logging. Os logs detalhados para APIs incluem dados de solicitação e resposta em cada log de API para ajudar a monitorar dados de entrada e saída e facilitar a depuração. Como isso pode criar arquivos de log grandes, o verbose logging está desabilitado por padrão. Ativar esse botão exibe a seguinte mensagem:
Texto do diálogo
Habilitar verbose logging
O verbose logging para APIs permite que o usuário decida se cada log de API deve conter dados de solicitação e resposta. Essa funcionalidade ajuda a monitorar dados de entrada/saída e depurar problemas de API.
ContinuarCancelar -
Enable debug mode until: Selecione para ativar o modo de depuração e inserir uma data e hora correspondente na qual o modo de depuração será desabilitado. O comprimento máximo de ativação é de duas semanas. Ativar esse botão exibe a seguinte mensagem:
Texto do diálogo
Habilitar modo de depuração
O modo de depuração ativa o rastreamento completo para todas as solicitações recebidas através desta URL. Quando ativado, o sistema captura o conteúdo completo de cada solicitação e resposta de API por até 24 horas. Isso inclui todas as operações acionadas pela API. Devido ao alto volume de dados gerado e ao possível impacto no armazenamento, o modo de depuração pode ser ativado por no máximo duas semanas.
ContinuarCancelar
Serviços
Configure serviços para sua API.

-
Service Name: Digite um nome para o serviço de API. Por padrão, esse campo é definido com o nome da operação.
-
Method: Selecione entre ALL, CUSTOM, DELETE, GET, POST ou PUT como o método de solicitação a ser usado para a operação selecionada. Selecionar ALL criará métodos de solicitação separados
DELETE,GET,POSTePUTpara a operação (o métodoCUSTOMnão está incluído).Nota
Os serviços de API que usam um método
CUSTOMnão terão documentação OpenAPI gerada através da página Portal Manager devido a uma limitação da especificação OpenAPI. -
Caminho: O caminho para a solicitação.
-
Projeto: (Visível apenas para APIs customizadas e APIs OData.) O nome do projeto do Studio.
-
Operação para Disparar: (Visível apenas para APIs customizadas e APIs OData.) O nome da operação sendo chamada.
-
Tipo de Resposta: (Visível apenas para APIs customizadas e APIs OData.) Este campo é obrigatório. Selecione entre Destino Final, Variável do Sistema ou Sem Resposta:
-
Destino Final: A resposta da API é o destino final da operação. Quando este tipo de resposta é selecionado, a operação deve ter (como destino final da cadeia de operações) uma atividade API Response do Studio. Se qualquer outro destino final for usado, a resposta da API estará vazia.
-
Variável do Sistema: A resposta da API é definida em uma variável Jitterbit na operação. Quando este tipo de resposta é selecionado, a operação deve ter (como parte de uma cadeia de operações) um script que define a variável Jitterbit
jitterbit.api.responseigual à resposta que você deseja que a API retorne. Se esta variável não estiver definida, a resposta da API estará vazia. -
Sem Resposta: A resposta da API está vazia. Se a solicitação para executar a operação selecionada for aceita, a API retornará uma resposta vazia imediata com código HTTP 202.
-
-
Ações: Passe o mouse sobre a linha de serviço para revelar ações adicionais:
-
Copiar URL do serviço API: Clique para copiar a URL do serviço API para a sua área de transferência. (Você verá uma confirmação da ação.)
-
Ir para operação: Abre o projeto do Studio em uma nova aba do navegador. A operação no campo Operação para Disparar fica destacada na tela de design do Studio. Esta ação está desativada para operações do Design Studio.
-
Duplicar: (Visível apenas para APIs customizadas e APIs OData.) Cria uma duplicata do serviço API. Você deve alterar o método de solicitação ou o Caminho, pois cada serviço API deve ter uma combinação única desses campos.
-
Excluir: Exclui o serviço API.
-
Ao clicar em uma linha de serviço API customizado, estas abas aparecem:

Aba de parâmetros de caminho
Quando parâmetros de solicitação são incluídos no Caminho, esta aba é preenchida com esses campos:

-
Parâmetro: Exibe os parâmetros de solicitação definidos no Caminho.
-
Descrição: Opcionalmente, insira uma descrição para os parâmetros de solicitação.
Aba de parâmetros de consulta
Esta aba permite adicionar parâmetros de consulta ao serviço API:

-
Adicionar Parâmetro: Clique para adicionar um parâmetro de consulta ao serviço API. Ao clicar, estes campos ficam disponíveis:
-
Parâmetro: Insira o nome do parâmetro de consulta.
-
Descrição: Opcionalmente, insira a descrição do parâmetro de consulta.
-
Excluir: Clique no ícone de exclusão ao lado de um parâmetro de consulta para excluir esse parâmetro.
-
Aba de Cabeçalhos
Esta aba permite adicionar cabeçalhos de solicitação ao serviço API:

-
Adicionar Parâmetro: Clique para adicionar um cabeçalho de solicitação ao serviço API. Ao clicar, estes campos ficam disponíveis:
-
Parâmetro: Insira o nome do cabeçalho de solicitação.
-
Descrição: Opcionalmente, insira a descrição do cabeçalho de solicitação.
-
Obrigatório: Selecione se o cabeçalho de solicitação deve ser obrigatório para cada solicitação do serviço API.
-
Excluir: Exclui o cabeçalho de solicitação.
-
Perfis de segurança
Configure perfis de segurança para a API. Essas configurações são opcionais.

-
Pesquisar: Digite qualquer parte do nome do perfil de segurança, tipo ou nome de usuário na caixa de pesquisa para filtrar a lista de serviços. Use apenas caracteres alfanuméricos. A pesquisa não diferencia maiúsculas de minúsculas.
-
Novo perfil de segurança: Abre um painel para configurar um novo perfil de segurança (consulte Perfis de Segurança):

A lista de perfis de segurança existentes para escolher é exibida em uma tabela com as seguintes colunas:
-
Atribuir: Use o botão de alternância para atribuir ou desatribuir o perfil de segurança à API.
Regras de atribuição de perfil de segurança
-
Múltiplos perfis: Você pode atribuir vários perfis de segurança com o mesmo tipo de autenticação a uma API. Apenas os tipos de autenticação
basiceAPI keypodem ser usados juntos. -
Alterações de publicação: Ao desatribuir um perfil de segurança de uma API usando o botão de alternância, a alteração é salva como rascunho. Você deve publicar a API para que a alteração entre em vigor. Até que a API seja publicada, o perfil de segurança ainda é considerado "em uso" e não pode ser excluído da página Perfis de Segurança.
-
-
Nome do Perfil: O nome do perfil de segurança.
-
Tipo: O tipo de autenticação, um de Anônimo, Chave de API, Básico ou OAuth 2.0.
-
Nome do Usuário: Exibe o nome de usuário para qualquer perfil de segurança que use autenticação Básica. Caso contrário, o tipo de autenticação é exibido.
-
Ações: Passe o mouse sobre a linha do perfil de segurança para revelar uma ação adicional:
- Ir para perfil de segurança: Abre a tela de configuração para o perfil de segurança.
Funções de usuário
Configure funções da organização cujos membros têm acesso à API. Essas configurações são opcionais.

Nota
Esta aba fica visível apenas para APIs personalizadas e APIs OData.
Você pode classificar a tabela por Função de Usuário clicando na linha de cabeçalho respectiva.
-
Pesquisar: Digite qualquer parte da função de usuário, permissão ou status na caixa de pesquisa para filtrar a lista de serviços. Use apenas caracteres alfanuméricos. A pesquisa não diferencia maiúsculas de minúsculas.
-
Nova função de usuário: Abre um painel para configurar uma nova função de usuário:

-
Nome da função: Digite um nome exclusivo para a função.
-
Permissões: Clique para abrir o menu e selecione pelo menos uma permissão na lista.
Regras de gerenciamento de funções
Estas regras se aplicam ao gerenciar funções em APIs:
- Usuários com permissão de Admin ou acesso ao ambiente de Escrita podem atribuir ou desatribuir funções a APIs.
- Usuários com permissão de Admin podem criar e atribuir novas funções.
- Usuários com permissão de Admin não podem ser desatribuídos de qualquer API por nenhum usuário.
-
Salvar: Salva a função e a adiciona à tabela de funções.
-
Cancelar: Fecha o painel sem salvar as alterações.
-
-
Permissões: As permissões que um usuário atualmente possui.
-
Status: Exibe se a função de usuário está ou não atribuída à API.
-
Ações: Passe o mouse sobre a linha da função de usuário para revelar uma ação adicional:
- Ir para função de usuário: Abre a página Gerenciamento de Usuários do Console de Gerenciamento.
Rodapé
O rodapé do painel mostra essas opções. Elas podem ser ativadas ou desativadas dependendo de quanto você já configurou:
-
Cancelar: Fecha o diálogo sem salvar.
-
Anterior: Retorna à etapa anterior.
-
Próximo: Avança para a próxima etapa.
-
Salvar como rascunho: Salva a API com status Rascunho e fica acessível na página APIs do Gerenciador de API. Uma API em rascunho não conta como uma URL de API contra sua cota de permissão da assinatura Harmony. Você pode acessar e concluir a configuração da API em rascunho na página APIs do Gerenciador de API.
-
Publicar: Salva a API com status Publicado. A API fica ativa e acessível em até cinco minutos. Uma API publicada conta como uma URL de API contra sua cota de permissão da assinatura Harmony. Você pode acessar a API publicada na página APIs do Gerenciador de API.
Importante
As operações acionadas por uma API personalizada do Gerenciador de API possuem registro em log adicional que pode ser habilitado. Para detalhes sobre o que aparece nos logs de operação e como habilitar o registro em log adicional, consulte Dados de solicitação e resposta da API em Logs de operação.