Como obter o token

Seu token de acesso autoriza você a usar o servidor Jump REST API. Para chamar uma REST API em sua integração, troque seu ID de cliente e segredo por um token de acesso em uma chamada de token OAuth 2.0.


Embora existam algumas maneiras de obter um token, aqui estão exemplos usando o aplicativo Postman e um comando cURL .

A biblioteca ou função HTTP do seu próprio ambiente pode ter campos usernameand passwordou um parâmetro auth no qual você passa seu ID de cliente e segredo. Você também pode adicionar seu ID de cliente codificado em Base64 e segredo em um Authorization: Basiccabeçalho.


Postman

Para gerar credenciais da API REST para os ambientes sandbox e ativos:

  1. Baixe Postman para seu ambiente.

  2. No Postman, selecione o POSTmétodo.

  3. Insira o https://api-uat.jumppag.com/oauth2/token URL da solicitação.

  4. Na aba Authorization , selecione o tipo Basic Auth . Digite seu ID de cliente na caixa Username e digite seu segredo na caixa Password .

  5. Clique em Enviar .

Em troca dessas credenciais, o servidor de autorização Jump retorna seu token de acesso no campo access_token:

{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "access_token": "<Access-Token>",
        "token_type": "Bearer",
        "expires_in": 3600
    }
}

Inclua este token portador no cabeçalho Authorization com o esquema de autenticação Bearer em chamadas de API REST para provar sua identidade e acessar recursos protegidos. Esta solicitação de amostra inclui um token portador:

curl -v --location --request POST 'https://api-uat.jumppag.com/transaction/checkout' \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer <Access-Token>"

Os tokens de acesso têm uma vida útil finita. O expires_incampo contém o número de segundos após o qual o token expira. Por exemplo, um token de acesso com um valor de expiração de 3600expira em uma hora a partir de quando a resposta foi gerada. Em geral, os tokens de acesso têm uma vida útil de 15 minutos ou oito horas, dependendo dos escopos associados.

Para detectar quando um token de acesso expira, escreva código para:

  • Acompanhe o expires_invalor na resposta do token.

  • Manipule o código de status HTTP 401 Unauthorized. O endpoint da API emite esse código de status quando detecta um token expirado.

Reutilize o token de acesso até que ele expire. Então, pegue um novo token.


cURL

  1. Baixe o cURL para seu ambiente.

Observação: no Windows, use um shell Bash para fazer chamadas cURL.

  1. Execute este comando, onde client_idestá seu ID de cliente e secretseu segredo:

curl -v --location --request POST 'https://uat-api.jumppag.com/oauth2/token' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic <Access-Credentials>'

Nota: Se você usar uma ferramenta de linha de comando diferente de cURL, defina o Acceptcabeçalho comoapplication/x-www-form-urlencoded.

Em troca dessas credenciais, o servidor de autorização Jump retorna seu token de acesso no access_tokencampo:

{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "access_token": "<Access-Token>",
        "token_type": "Bearer",
        "expires_in": 3600
    }
}

Inclua este token portador no Authorizationcabeçalho com o Beareresquema de autenticação em chamadas de API REST para provar sua identidade e acessar recursos protegidos. Esta solicitação de amostra inclui um token portador:

curl -v --location --request GET 'https://uat-api.jumppag.com/transactions/' \
        --header "Content-Type: application/json" \
        --header "Authorization: Bearer <Access-Token>"

Os tokens de acesso têm uma vida útil finita. O expires_incampo contém o número de segundos após o qual o token expira. Por exemplo, um token de acesso com um valor de expiração de 3600expira em uma hora a partir de quando a resposta foi gerada. Em geral, os tokens de acesso têm uma vida útil de 15 minutos ou oito horas, dependendo dos escopos associados.

Para detectar quando um token de acesso expira, escreva código para:

  • Acompanhe o expires_invalor na resposta do token.

  • Manipule o código de status HTTP 401 Unauthorized. O endpoint da API emite esse código de status quando detecta um token expirado.

Reutilize o token de acesso até que ele expire. Então, pegue um novo token.

Atualizado

Isto foi útil?