IMPORTANTE: esta documentação foi descontinuada. Leia a documentação Utilização de Contas atualizada no nosso novo portal de documentação.

Contas (Accounts)

Sempre que você precisar utilizar alguma senha, chave privada, token de autenticação, entre outros, recomendamos muito que você recorra a uma conta cadastrada na Plataforma. Assim, os seus dados são criptografados e não ficam expostos durante a execução da integração.

Tipos de Contas

Basic

Recorra a esse tipo de conta quando você utilizar um componente ou serviço que necessite de uma autenticação de usuário/senha.

USERNAME: nome do usuário
PASSWORD: senha

Custom Auth Header

Recorra a esse tipo de conta caso algum endpoint necessite de um header customizado de autenticação.

HEADER-NAME: nome do header
HEADER-VALUE: o valor do header

OAuth Bearer

Recorra a esse tipo de conta quando precisar armazenar um token do tipo OAuth. O token será atribuído ao parâmetro "Authorization" no header de requisição.

TOKEN: o token OAuth

Private Key

Tipo de conta que armazena uma chave privada.

Exemplo:

KEY: chave privada
PASSPHRASE: senha da chave privada

Public Key

Esse tipo de conta armazena uma chave pública.

Exemplo:

-----BEGIN PUBLIC KEY-----
MIGeMA0GCSqGSIb3DQEBAQUAA4GMADCBiAKBgF2duc4+xxNKlMO9bUud4bzGnuAT
kQVX3bM/gzxISrgw7B1AzJwAOT5UChBoIKfmISaaVVY9+/fTpI1szihSqTyemdHn
-----END PUBLIC KEY-----

KEY: chave pública

Certificate Chain

Configura uma cadeia de certificados. Utilizada para endpoints que necessitam de autenticação 2 way SSL ou de um certificado do lado cliente. A cadeia de certificado deve ser passada na ordem correta, e no formato pem.

Para converter sua chave, você pode fazer através do OpenSSL via linha de comando, Ex: openssl pkcs12 -in mycert_xpto.p12 -out myapp.pem

Exemplo:

CHAIN: cadeia de certificados completa
PASSWORD: senha da chave privada, caso necessário

Google Key

Chave de serviço para acessar APIs do Google.

Exemplo:

{
  "type": "service_account",
  "project_id": "project_id",
  "private_key_id": "dfdsfrfr43r43r4refbcceceabf8055a12a",
  "private_key": "-----BEGIN PRIVATE KEY-----\n-----END PRIVATE KEY-----\n",
  "client_email": "user@DOMAIN.iam.gserviceaccount.com",
  "client_id": "123456576788888899",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://accounts.google.com/o/oauth2/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/storage%40project.iam.gserviceaccount.com"
}

KEY: chave do Google
SCOPES: escopos necessários para acessar determinada API (separados por vírgula). Para saber mais sobre escopos do Google, clique aqui.

Kerberos

Conta que armazena a Keytab para autenticações em ambientes que utilizam Kerberos.

KEYTAB: base64 do arquivo Keytab
PRINCIPAL: usuário dessa Keytab (ex.: user@DOMAIN)

SMTP Auth And Properties

Conta utilizada somente para o Mail Connector. Ela configura os dados de acesso ao servidor SMTP para envio de e-mail.

HOST: nome do host do servidor SMTP
PORT: porta de acesso ao servidor SMTP
USERNAME: e-mail do usuário
PASSWORD: senha do e-mail
STARTTLS_ENABLE: valores “true” ou “false” - se “true”, o acesso será via SSL.
AUTH: tipo de autenticação do servidor de e-mail

OAuth 2

OAuth é um padrão aberto para autorização, comumente utilizado para permitir que os usuários da Internet possam fazer logon em sites de terceiros usando as suas contas do Google, Microsoft, etc. sem expor as senhas. OAuth lhes fornece um "acesso seguro delegado" aos recursos do servidor em nome do proprietário do recurso.

PROVEDOR: provedor OAuth
SCOPES: escopos de acesso do OAuth

Suportamos os seguintes provedores:

Microsoft: é obrigatório o escopo "offline_access" para utilização na Plataforma Digibee. Também é importante lembrar que esse provedor aceita apenas contas pessoais.
Google
Mercado Livre

Secret Key

Chave secreta utilizada para componentes de criptografia.

KEY: chave secreta

API Key

Conta que configura uma API Key para ser utilizada em endpoints que necessitam de uma API Key.

URL-PARAM-NAME: nome do query parameter em que a API Key configurada será utilizada

API-KEY: valor da API Key a ser utilizada

IMPORTANTE: os provedores abaixo têm um prazo de expiração para seu token de autenticação. Com isso, é necessário atualizar as configurações de suas contas conforme o prazo previsto por eles.

Microsoft - 3 meses
Google - 6 meses
Mercado Livre - 6 meses