Skip to main content

Login and credentials using SWAGGER

This page will help you log in and save your credentials for your new integration, with examples of how to use Swagger.​

Introduction​

Swagger is basically a set of tools that helps us generate project documentation and even make calls to product endpoints.

Step by step​

1. Login​

Access our GroupLinkAPI Login

Click on "Try it out", fill in your email and password information and click on "Execute"

Your access token will be returned, copy it to use it to save your credentials

2. Save credentials​

Access our GroupLinkAPI OrganizationVault

Click on the gray padlock in the upper right corner, paste your access token and click on "Authorize"

Click on "Try it out" and fill in the information in the body of the request and click on "Execute".

Note: type and data change according to the chosen storage (S3, Azure, Google or direct-link), you can check more details by clicking on "Schema" in the documentation itself.

You will receive the ID of your new credential

Example of creating a bucket and access key in AWS: Bucket in AWS to receive files

3. List credentials​

Access GroupLinkAPI OrganizationVaultList

If you have not yet logged in with your access token in Swagger, click on the gray padlock in the upper right corner, paste your token and click on "Authorize"

Click on "Try it out" and "Execute"

The return will be a list of credentials with their IDs and information, take the opportunity to check what you registered.

4. If you want to delete a credential​

Access GroupLinkAPI OrganizationVaultDelete

If you have not yet logged in with your access token in Swagger, click on the gray padlock in the upper right corner, paste your token and click on "Authorize"

Fill in the ID of the credential you want to delete and click on "Execute"

The return should be an HTTP 204