Recursos para IA

Boas práticas para a integração do OAuth

Ao usar o OAuth, é importante considerar alguns aspectos para que a integração funcione corretamente.

Abaixo, você encontrará um guia para possíveis erros e boas práticas para utilização do OAuth.

Uso correto de valores em headers de solicitação

Use os headers accept e content-type em todas as solicitações POST e evite adicionar valores a headers não relacionados à integração para evitar erros de resposta.

oauth_header

Uso correto dos valores 'params'

Ao fazer a chamada POST, utilize apenas os valores params solicitados e evite adicionar qualquer valor não obrigatório, caso contrário, receberá um código de erro em resposta.

oauth_params

Uso correto dos Query Params

Lembre-se de não enviar nenhum parâmetro dentro dos Query Params. Envie os parâmetros no request body conforme indicado em nossa Referência da API.

oauth_queryparams

Uso correto do campo 'grant_type'

Use o campo grant_type com os valores authorization_code ou client_credentials em todas as suas requisições. Tenha em mente que enviar qualquer outro valor pode resultar em um erro na resposta.

oauth_grant_type

Usando o campo 'state' na solicitação do 'autorization code'

Para aumentar a segurança da integração, inclua o parâmetro state no fluxo de solicitação do authorization code. Isso garantirá que a resposta pertença a uma solicitação iniciada pelo mesmo aplicativo.

Certifique-se de que o redirect_uri seja uma URL estática. Se desejar enviar parâmetros adicionais nessa URL, utilize o parâmetro state para incluir essas informações. Caso contrário, a chamada receberá uma resposta de erro se o redirect_uri não corresponder exatamente à configuração do aplicativo.

oauth_state