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.
GET All
No Swagger localize a entidade Customer em seguida selecione o payload GET. Clique no botão Try It Out para liberar a pesquisa logo após execute a requisição.
Será disponibilizado o modelo de Response do método GET All.
Get com parâmetros
No Swagger localize a entidade Customer em seguida selecione o payload GET. Clique no botão Try It Out para liberar a pesquisa.
Insira o parâmetro ex,: Code:#155c:26 logo após execute a requisição.
Será disponibilizado o modelo de Response do método GET com Parâmetros.
GET utilizando o Id.
No Swagger localize a entidade Customer em seguida selecione o payload GET. Clique no botão Try It Out para liberar a pesquisa logo após execute a requisição.
Coletar o id disponibilizado, nesse exemplo: "id": "41c97285-31d6-4da5-8ec6-d0f23240d038"
Na entidade Customer selecione o payload GET/{id}. Clique no botão Try It Out cole o id armazenado e execute a requisição.
Será disponibilizado o modelo de Response do método GET com id.
GET All
No Swagger localize a entidade Organization em seguida selecione o payload GET. Clique no botão Try It Out para liberar a pesquisa logo após execute a requisição.
Será disponibilizado o modelo de Response do método GET All.
Get com parâmetros
No Swagger localize a entidade Organization em seguida selecione o payload GET. Clique no botão Try It Out para liberar a pesquisa.
Na seção Parameters insira o parâmetro ex,: Name: GRR-QA(STG) logo após execute a requisição.
Será disponibilizado o modelo de Response do método GET com Parâmetros.
GET utilizando o Id.
No Swagger localize a entidade Organization em seguida selecione o payload GET. Clique no botão Try It Out para liberar a pesquisa logo após execute a requisição.
Em seguida armazena a informação do campo id, nesse exemplo será "id": "9495d9da-33be-4634-a67e-22eced59274d"
Será disponibilizado o modelo de Response do método GET com id.
GET All
No Swagger localize a entidade Currency em seguida selecione o payload GET. Clique no botão Try It Out para liberar a pesquisa logo após execute a requisição.
Será disponibilizado o modelo de Response do método GET All.
Get com parâmetros
No Swagger localize a entidade Currency em seguida selecione o payload GET. Clique no botão Try It Out para liberar a pesquisa logo após execute a requisição.
Armazene a informação do campo Code.
Na seção Parameters cole a informação armazenada no campo Code, em seguida clique em Execute.
Será disponibilizado o modelo de Response do método GET com Parâmetros.
GET utilizando o Id.
No Swagger localize a entidade Currency em seguida selecione o payload GET. Clique no botão Try It Out para liberar a pesquisa logo após execute a requisição.
Em seguida armazena a informação do campo id, nesse exemplo será "id": "bbff1352-0256-4ac9-8aaa-df0f619f3d37"
Localize a entidade Currency em seguida selecione o payload GET/{id}. Clique no botão Try It Out cole o id armazenado e execute a requisição.
Será disponibilizado o modelo de Response do método GET com Id.
VERIFICAR, ERRO 500
GET All
No Swagger localize a entidade Plan em seguida selecione o payload GET. Clique no botão Try It Out para liberar a pesquisa logo após execute a requisição.
Será disponibilizado o Response do GET All.
Get com parâmetros
No Swagger localize a entidade Plan em seguida selecione o payload GET. Clique no botão Try It Out para liberar a pesquisa logo após execute a requisição.
Na seção Parameters realize o preenchimento dos campos, em seguida clique em Execute.
Será disponibilizado o modelo de Response do GET com Parâmetros.
GET utilizando o Id.
No Swagger localize a entidade Plan em seguida selecione o payload GET. Clique no botão Try It Out para liberar a pesquisa logo após execute a requisição.
Coletar o id disponibilizado, nesse exemplo: "id": "5d5871cd-21df-49c8-a138-09430d526448"
Localize a entidade Plan em seguida selecione o payload GET/{id}. Clique no botão Try It Out cole o id armazenado e execute a requisição.
Será disponibilizado o modelo de Response do GET{id}
GET utilizando o campo período.
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 seguir clique em Execute
Será disponibilizado o modelo de response do GET/Subscriptions
GET das subscrições canceladas.
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 CancellationDate a data para consulta, em seguir clique em Execute
Será disponibilizado o modelo de response do GET/Subscriptions com o parâmetro para as subscrições canceladas.
Get com parâmetros
pausa
No Swagger localize a entidade Plan em seguida selecione o payload GET. Clique no botão Try It Out para liberar a pesquisa logo após execute a requisição.
Response do GET com Parâmetros na entidade Plano
