Criar REST APIs com script

Crie uma REST API com script para definir os endpoints do serviço Web.

Antes de Iniciar

Função necessária: web_service_admin

Por Que e Quando Desempenhar Esta Tarefa

Por padrão, as REST APIs de script contêm uma ACL que proíbe os usuários com a função snc_external de fazer solicitações à API.

Procedimento

1. Navegar até Todos > Serviços web do sistema > Scripted REST APIs.
2. Clique em Nova.
3. Insira um Nome para o serviço.
   O ID da API é definido automaticamente com base no Nome. Você pode modificar o ID da API, se necessário.
4. Clique em Enviar.

O que Fazer Depois

Depois de criar a API, configure o serviço conforme necessário, como criando recursos, atribuindo ACLs ou especificando formatos de solicitação e resposta compatíveis.

• Criar um recurso de REST API com script
  Crie um recurso de REST API com script para definir o método HTTP, o script de processamento e para substituir as configurações do serviço primário.
• Definir cabeçalhos de scripted REST API
  Defina cabeçalhos de REST API com script para controlar quais cabeçalhos a API aceita e com os quais pode responder.
• Definir parâmetros de consulta disponíveis
  Defina os parâmetros de consulta disponíveis para controlar quais valores um usuário solicitante pode passar no URI da solicitação.
• Associar parâmetros de consulta a um recurso
  Associe parâmetros de consulta de REST API de script a um recurso.
• Configurar uma REST API com script para exigir uma ACL
  As solicitações para REST APIs de script respeitam as ACLs da plataforma e o usuário solicitante deve atender a todos os requisitos de ACL de tabela para acessar os dados da instância. Além disso, você pode configurar a REST API de script para exigir uma ACL específica.
• Habilitar controle de versões para REST APIs com script
  Habilite o controle de versões para uma REST API com script para fornecer várias versões da API enquanto mantém a compatibilidade com as integrações existentes.
• Solicitação de controle e tipo de conteúdo de resposta
  Controla quais tipos de conteúdo são permitidos em solicitações e respostas de REST APIs com script.
• Controlando o tamanho máximo da solicitação
  Você pode especificar o tamanho máximo de arquivo permitido em uma carga de solicitação de REST API com script.