Ir para o conteúdo

Transforme as suas conexões em um bônus de fim de ano com o nosso novo Programa de Indicação de Clientes! Saiba mais

✕

Esta documentação é para a versão 4 e posterior do App Builder, o novo nome do Vinyl. Acesse a documentação do Vinyl aqui.

✕

Configurando a autenticação de chave de API no Jitterbit App Builder

As APIs REST do App Builder podem ser protegidas usando chaves de API. Configurar a autenticação de chave de API envolve os seguintes procedimentos:

  1. Criando um provedor de segurança do App Builder.
  2. Gerando uma chave de API.

Requisitos

Para prosseguir, você precisará de:

  • Acesso de administrador ao App Builder.
  • API REST para testes.

Criando um provedor de segurança do App Builder

  1. A autenticação de chave de API é habilitada no App Builder por meio de um provedor de segurança. Comece entrando no App Builder como administrador.
  2. Navegue até o IDE
  3. Clique no botão Provedores de segurança
  4. No painel Autenticação do usuário, clique no botão + Autenticação do usuário

  5. Forneça o seguinte:

    • Nome: Chave API
    • Tipo: Chave API
    • Ativo: Verificado
    • Prioridade: Um inteiro entre 10 e 100 (por exemplo, 50). Observe que esse valor deve ser único.

  6. Clique no botão Salvar

Gerando uma chave de API

Chaves de API são associadas a usuários do App Builder. Para gerar uma nova chave de API, comece entrando no App Builder como administrador.

  1. Navegue até o IDE
  2. Clique no botão Gerenciamento de usuários
  3. No painel Usuários, localize o usuário para o qual você gostaria de gerar uma chave de API
  4. Clique no ícone Abrir registro (Popup)
  5. Clique no ícone Chaves (Chave)
  6. Clique no botão Criar

  7. Forneça o seguinte:

    • Provedor: Chave API
    • Descrição: Descrição do propósito principal. Por exemplo: Fornece acesso à API REST

    • Expira em: Tempo de vida da chave da API em minutos. Uma vez gerada, o tempo de vida não pode ser alterado.

      API_expire.png

  8. Clique no botão Salvar

Observe a chave de API gerada. Ela assumirá a forma de um inteiro de 128 bits codificado em base64url. Exemplo: DLOo9sPS5slJEMHpXBFt3g

Testando a chave da API

A seguir, demonstramos como autenticar uma solicitação de API REST usando uma chave de API.

GET /rest/v1/sales/customers HTTP/1.1
Host: example.com:443
Accept: application/json
X-API-Key: DLOo9sPS5slJEMHpXBFt3g