Você pode testar esta rota diretamente em nossa documentação interativa.

Use esta rota quando você tem o token de domínio e precisa do token de um host específico. Para listar todos os hosts do domínio de uma vez, use Obter Tokens de Acesso.

​
Endpoint

POST /api/externalAPIs/public/domainAccess/getHostToken

​
Autenticação

Inclua o token de domínio no cabeçalho da requisição:

Authorization: Bearer {SEU_DOMAIN_TOKEN}

Esta rota aceita somente token de domínio. Um token de host é recusado com 403.

​
Parâmetros

hostId
string
required

ID do host (UUID). O host precisa pertencer ao domínio do token.

​
Exemplo

curl -X POST '{{BASE_URL}}/api/externalAPIs/public/domainAccess/getHostToken' \
  -H 'Authorization: Bearer {SEU_DOMAIN_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "hostId": "1754b7e6-dbd7-4ca3-a843-7f06fad4e4c0"
  }'

​
Resposta

O token devolvido depende do domínio do host. O campo source diz de onde ele veio.

​
Host de domínio comum

{
  "code": 200,
  "message": "OK",
  "data": {
    "host_id": "1754b7e6-dbd7-4ca3-a843-7f06fad4e4c0",
    "host_slug": "slug-do-host",
    "source": "domain_access_data",
    "host_token": "token-de-acesso-do-host"
  }
}

​
Host do domínio Hinova

{
  "code": 200,
  "message": "OK",
  "data": {
    "host_id": "1754b7e6-dbd7-4ca3-a843-7f06fad4e4c0",
    "host_slug": "slug-do-host",
    "source": "hinova_access_data",
    "our_token_sga": "token-do-host-para-o-sga",
    "our_token_crm": "token-do-host-para-o-crm"
  }
}

Com qualquer um dos dois tokens você consulta os demais dados do host em Dados de Acesso Hinova.

​
Campos da Resposta

host_id
string

ID do host.

host_slug
string

Slug do host.

source
string

Origem do token: domain_access_data para hosts de domínio comum, hinova_access_data para hosts do domínio Hinova.

host_token
string

Token de acesso do host. Presente quando source é domain_access_data.

our_token_sga
string

Token do host para as chamadas do SGA. Presente quando source é hinova_access_data.

our_token_crm
string

Token do host para as chamadas do CRM. Presente quando source é hinova_access_data.

​
Erros

CódigoDescrição
400hostId ausente ou fora do formato UUID
401Token ausente ou inválido, ou host que não pertence ao domínio do token
403O token não é de domínio, ou o host não pertence ao domínio do token
404O host não tem token ativo. Em host do domínio Hinova, indica que o acesso Hinova ainda não foi configurado
500Erro interno do servidor
503Não foi possível validar o token agora. O token não foi recusado: tente novamente

Host de outro domínio, host excluído e host inexistente recebem a mesma recusa.

​
Segurança

Trate os tokens devolvidos como segredos. Não os exponha em clientes (web/mobile) nem os registre em logs.

  • Use sempre HTTPS e chame esta rota a partir do seu backend.
  • O token de domínio alcança todos os hosts do domínio. Guarde-o com o mesmo cuidado.
Obter Tokens de AcessoDados de Acesso Hinova