Autenticação

Todos os recursos desta API necessitam de um token de autenticação no Header da requisição. Para obter esse token será necessária uma requisição HTTP utilizando o método POST e passando os parâmetros conforme a seguir:

Header

Content-Type: application/x-www-form-urlencoded - Tipo de conteúdo que será enviado no corpo da requisição.

Body

client_id: Identificação de acesso do cliente. Informados pela equipe de suporte durante ativação.

client_secret: Segredo de acesso do cliente. Informados pela equipe de suporte durante ativação.

grant_type: valor fixo "client_credentials", que informa o método de autenticação na ferramenta.

Exemplo

POST 
`https://iam-hubanbima.rtm.net.br/auth/realms/hub-anbima/protocol/openid-connect/token`

HEADER
Content-Type: application/x-www-form-urlencoded

BODY

client_id: string
client_secret: string
grant_type: string

cURL

curl --location --globoff 'https://iam-hubanbima.rtm.net.br/auth/realms/hub-anbima/protocol/openid-connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id={{client_id}}' \
--data-urlencode 'client_secret={{client_secret}}' \
--data-urlencode 'grant_type=client_credentials'

Retorno

Status code - 200

{
    "access_token": string,
    "expires_in": number,
    "refresh_expires_in": number,
    "refresh_token": string,
    "token_type": string,
    "not-before-policy": number,
    "session_state": string,
    "scope": string
}

Status Code - 401

{
    "error": string,
    "error_description": string
}

Requisições

Assim que obtiver o access_token, para poder acessar os outros recursos da API, será necessário passar o header de "Authorization" no formato Bearer em todas as requisições posteriores até a expiração do token. Segue abaixo o formato necessário:

Header

Authorization: Bearer {access_token}

URLs

Ambiente	Tipo	URL
Homologação	Autenticação	https://iam-cert-mercado-hubanbima.rtm.net.br/realms/anbima-hub/protocol/openid-connect/token
	API	https://api-cert-mercado-hubanbima.rtm.net.br/anbima-request
	Portal	https://hubanbima-cert-mercado.rtm.net.br
Produção	Autenticação	https://iam-hubanbima.rtm.net.br/realms/anbima-hub/protocol/openid-connect/token
	API	https://api-hubanbima.rtm.net.br/anbima-request
	Portal	https://hubanbima.rtm.net.br