Como eu faço para criar uma consulta de listas, buscas e filtros usando o Swagger do Gestão de Receita Recorrente - GRR ?
Requisitos:
Para utilizar nossa API é necessário que você tenha familiaridade com a terminologia básica utilizada no desenvolvimento de web services REST. É possível desenvolver a integração com praticamente todas as linguagens de programação disponíveis no mercado. Abaixo seguem os nomes das entidades que serão mencionadas nessa documentação e suas especificações.
- Ter realizado o procedimento da Assinatura na plataforma;
- Ter realizado o procedimento de Geração do Token na plataforma do GRR - Gestão de Receita Recorrente;
- Possuir acesso ao Swagger.
A seguir iremos realizar o procedimento de geração e armazenamento do token para realizar a autenticação no Swagger, com esse procedimento será possível realizar as criações de assinaturas, consultas, pausas e cancelamentos.
Acesse o GRR, clique no menu Configurações em seguida clique no botão Gerar Token logo após selecione o link URL do campo Integrações.
Página do Swagger disponibilizado.
Selecione o botão Authorize, digite o texto Bearer e cole o token gerado na tela de configurações, em seguida clique em Authorize.
Esse é o resultado esperado.
Nesta seção iremos demonstrar como realizar a pesquisa dos registros utilizando 3 métodos: GET por período, GET de Cancelamento no dia, GET com Pause, GET fatura em atraso e GET fatura em atraso há mais de X dias.
Certifique-se que sua chave da API está preenchida no topo da página para que este recurso funcione da maneira correta. Você poderá conferir a lista de recursos que podem ser manipulados através da API do GRR. Cada recurso possui uma série de métodos, como criar e atualizar. Clicando em cada um dos métodos, você poderá verificar a lista de parâmetros, possíveis retornos e também um formulário. Este formulário pode ser utilizado para efetuar requisições reais na API.
Nesta seção será apresentado o procedimento para realizar a pesquisa no Swagger utilizando o campo período no payload GET ALL.
No Swagger localize a entidade Subscription em seguida selecione o payload GET/Subscriptions. Clique no botão Try It Out para liberar a pesquisa.
Inserir nos campos SubscriptionStart e SubscriptionEnd o período para consulta, em seguida clique no botão Execute.
Será disponibilizado o modelo de response do GET/Subscriptions.
Nesta seção será apresentado o procedimento para realizar a pesquisa no Swagger para as subscrições canceladas no dia.
No Swagger localize a entidade Subscription em seguida selecione o payload GET/Subscriptions. Clique no botão Try It Out para liberar a pesquisa.
Inserir no campo CancellationDate a data do cancelamento realizado no dia, em seguida clique no botão Execute.
Será disponibilizado o modelo de response do GET/Subscriptions com o parâmetro para as subscrições canceladas no dia informado.
Nesta seção será apresentado o procedimento para realizar a pesquisa no Swagger relacionados as subscrições pausadas. Identificando quem está "suspenso" para um possível bloqueio de acesso.
No Swagger localize a entidade Subscription em seguida selecione o payload GET/subscriptions. Clique no botão Try It Out para liberar a pesquisa logo após execute a requisição.
No response do GET, localize a seção SubscriptionPause e armazene o id.
Localize a entidade SubscriptionPause em seguida selecione o payload GET/subscriptions/pause/{id}. Clique no botão Try It Out para liberar a pesquisa e insira o id armazenado executando a requisição.
Será disponibilizado o modelo de response do GET/Subscriptions/{id}.
Nesta seção será apresentado o procedimento para realizar a pesquisa no Swagger para as subscrições que tenham suas faturas em atraso. Assim podendo realizar um possível bloqueio de serviço.
No Swagger localize a entidade Bill em seguida selecione o payload GET/bills. Clique no botão Try It Out para liberar a pesquisa.
Inserir no campo Status igual a 3 (AwaitingPayment), em seguida clique no botão Execute.
Será disponibilizado o modelo de response do GET/bills com o parâmetro de Status igual a 3 (AwaitingPayment).
Nesta seção será apresentado o procedimento para realizar a pesquisa no Swagger, para as subscrições que tenham suas faturas em atraso há mais de X dias. Identificando quem está em atraso por um período determinado e enviar para empresa de cobrança
No Swagger localize a entidade Bill em seguida selecione o payload GET/bills. Clique no botão Try It Out para liberar a pesquisa.
Inserir no campo Status igual a 3 (AwaitingPayment), em seguida clique no botão Execute.
Será disponibilizado o modelo de response do GET/bills com o parâmetro de Status igual a 3 (AwaitingPayment).
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas