Requesições da API

Para fazer uma solicitação de API REST, você combina o método HTTP GET, POST, PUT, PATCH ou DELETE, a URL para o serviço de API, o URI para um recurso para consultar, enviar dados, atualizar ou excluir e um ou mais

A URL para o serviço de API é:

• Homologação: https://api-uat.jumppag.com

• Produção: https://api.jumppag.com

Opcionalmente, você pode incluir parâmetros de consulta em chamadas GET para filtrar, limitar o tamanho e classificar os dados nas respostas.

A maioria das chamadas GET, POST, PUT e PATCH exigem um corpo de solicitação JSON.

Este exemplo de solicitação de token oauth:

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

Esta solicitação de exemplo lista transações:

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

Parâmetros de consulta

Para a maioria das chamadas REST GET, você pode incluir um ou mais parâmetros de consulta no URI da solicitação para filtrar, limitar o tamanho e classificar os dados em uma resposta de API. Para parâmetros de filtro, consulte as chamadas GET individuais.

Para limitar, ou paginar, e classificar os dados que são retornados em algumas respostas de API, use estes, ou parâmetros de consulta semelhantes:

Observação: nem todos os parâmetros de paginação estão disponíveis para todas as APIs.

Parâmetro	Tipo	Min	Max	Descrição
limit	integer	1	40	O número de itens a serem retornados na resposta.
page	integer	1	9999999	O número da página indica qual conjunto de itens será retornado na resposta. Então, a combinação de page=1 e limit=20 retorna os primeiros 20 itens. A combinação de page=2 e limit=20 retorna os itens de 21 a 40.
sort	string Format: item,(asc|desc)	null		Classifica os itens na resposta por filtro em ordem crescente ou decrescente. Ex.: sort=id,desc (Esta combinação retorna uma lista em ordem decrescente com base no id.)
start_time	string Internet date and time format	null		A data e hora de início para o intervalo a ser exibido na resposta, no formato de data e hora da Internet. Ex.: start_time=2021-09-05T11:00:00Z.
end_time	string Internet date and time format	null		A data e hora de término para o intervalo a ser exibido na resposta, no formato de data e hora da Internet. Ex.: end_time=2021-09-05T11:00:00Z.
customer_id	string	1	255	Classifica os itens na resposta procurando pelo customer_id que foi fornecido pelo seu sistema.
transaction_id	string	1	255	Classifica os itens na resposta procurando pelo transaction_id que foi fornecido pelo seu sistema. Para obter vários transaction_id, envie cada transaction_id separando por vírgula (,). Ex.: 8fecdfcc-4e4d-11ee,8fece5ee-4e4d-11ee,d42953be-4e4d-11ee

Por exemplo, a API de transações retorna detalhes de dez transações começando com a segunda página, classificadas por ID decrescente na resposta:

curl -v --location --request GET 'https://api-uat.jumppag.com/transactions?limit=10&page=2&sort=id,desc' \
        --header "Content-Type: application/json" \
        --header "Authorization: Bearer < Access-Token >"

Cabeçalhos de solicitação HTTP

Os cabeçalhos de solicitação HTTP comumente usados ​​são:

Content-Type

O formato de resposta, que é necessário para operações com um corpo de resposta. A sintaxe é:

Content-Type: application/format

Onde o formato é json.

Authorization

Necessário para obter um token de acesso ou fazer chamadas de API:

• Obtenha um token de acesso Ao criar em Homologação ou Produção REST API ativo, a Jump gera um conjunto de IDs de cliente OAuth 2.0 e credenciais secretas para a Homologação ou Produção. Ao fazer uma chamada get an access token, defina o cabeçalho Authorization para essas credenciais para o ambiente no qual você está fazendo a chamada.

  Em troca dessas credenciais, o servidor de autorização da Jump pemite um token de acesso bearer que você usa para autorização ao fazer solicitações REST API.

  Um bearer token permite que você conclua ações com a aprovação do proprietário do recurso.

• Fazer chamadas de API REST Inclua o token de acesso no cabeçalho Authorization com o esquema de autenticação Bearer: Authorization: Bearer <Access-Token>