Central do desenvolvedor

Autorização oAuth

POST /esignglobal/v1/oauth2/accessToken

Descrição da interface

Através deapp_ideapp_secretobter autenticaçãoaccess_token,usado para solicitar a API eSignGlobal na identidade de um utilizador específico. O tempo de validade do Token é de 24 horas.

Parâmetros de pedido

Nome do parâmetro

Tipo

Obrigatório

Descrição

client_id

string

true

Conta da aplicação, ou seja, app_id

Registe primeiro uma conta eSignGlobal e crie uma aplicação para obter.

client_secret

string

true

Palavra-passe da aplicação, ou seja, app_secret

Registe primeiro uma conta eSignGlobal e crie uma aplicação para obter.

grant_type

string

true

Tipo de autorização, suporta os seguintes tipos:

client_credentials:Baseado em client_id e client_secret para obter access_token

authorization_code:Requer a participação do utilizador no processo de autorização (válido por 365 dias naturais). Após a autorização, pode obter access_token e refresh_token

refresh_token:Dentro do período de validade da autorização e se o refresh_token ainda for válido, pode prolongar a validade do refresh_token através de uma operação de atualização

code

string

false

Código de autorização, devolvido pelo eSignGlobal após a autorização do utilizador, obrigatório quando grant_type é authorization_code

refresh_token

string

false

Token de atualização, só é necessário fornecer o token de atualização quando grant_type é refresh_token

Todos os parâmetros devem ser enviados através de multipart/form-data no formato de formulário, não pode ser usado como parâmetro de consulta de URL ou corpo de pedido JSON.

Exemplo de pedido

curl --location 'http://………………/esignglobal/v1/oauth2/accessToken' \
--form 'client_id="LZn…………g89"' \
--form 'client_secret="5ugL0rM………………Yne7b"' \
--form 'grant_type="client_credentials"' \

Parâmetros de resposta

Nome do parâmetro

Tipo

Descrição

access_token

string

Token de AutenticaçãoUsado para autenticação de pedidos de API, válido por 1 dia natural

expires_in

int

Tempo restante até à expiração do Token, em segundos

scope

string

Âmbito de Permissões

  • Quando grant_type é client_credentials, retorna o valor fixo:read-write
  • Quando grant_type é authorization_code ou refresh_token, retorna o âmbito de autorização correspondente

token_type

string

Tipo de Token

Valor fixo: bearer

refresh_token

string

Usado para renovar o token, retornado apenas quando grant_type é authorization_code ou refresh_token, válido por 30 dias naturais, após a expiração é necessário reautorizar

Exemplo de Resposta

{
    "access_token": "eyJhbGciOiJIUzI1N………………th1pMM3oYk",
    "expires_in": 86398,
    "scope": "read-write",
    "token_type": "bearer"
}

 

Descrição da interface
Parâmetros de pedido
Exemplo de pedido
Parâmetros de resposta
Exemplo de Resposta