Pular para o conteúdo principal

Login e credenciais usando SWAGGER

Esta página irá ajudá-lo a fazer login e salvar suas credenciais para sua nova integração, com exemplos de como usar o Swagger.​

Introdução​

Swagger é basicamente um conjunto de ferramentas que nos ajuda a gerar documentação de projetos e até mesmo fazer chamadas para endpoints de produtos.

Passo a passo​

1. Login​

Acesse nosso GroupLinkAPI Login

Clique em "Try it out", preencha suas informações de e-mail e senha e clique em "Execute"

Seu token de acesso será retornado, copie-o para usá-lo para salvar suas credenciais

2. Salvar credenciais​

Acesse nosso GroupLinkAPI OrganizationVault

Clique no cadeado cinza no canto superior direito, cole seu token de acesso e clique em "Authorize"

Clique em "Try it out" e preencha as informações no corpo da solicitação e clique em "Execute".

Nota: o tipo e os dados mudam de acordo com o armazenamento escolhido (S3, Azure, Google ou direct-link), você pode verificar mais detalhes clicando em "Schema" na própria documentação.

Você receberá o ID da sua nova credencial

Exemplo de criação de um bucket e chave de acesso na AWS: Bucket na AWS para recebimento dos arquivos

3. Listar credenciais​

Acesse GroupLinkAPI OrganizationVaultList

Se você ainda não fez login com seu token de acesso no Swagger, clique no cadeado cinza no canto superior direito, cole seu token e clique em "Authorize"
Clique em "Try it out" e "Execute"

O retorno será uma lista de credenciais com seus IDs e informações, aproveite para verificar o que você registrou.

4. Se você quiser deletar uma credencial​

Acesse GroupLinkAPI OrganizationVaultDelete

Se você ainda não fez login com seu token de acesso no Swagger, clique no cadeado cinza no canto superior direito, cole seu token e clique em "Authorize"

Preencha o ID da credencial que você deseja deletar e clique em "Execute"

O retorno deve ser um HTTP 204