Overview
The LinkSquares API and SDK Reference Guide can be accessed by downloading the API JSON file included as an attachment here and uploading it to Swagger.
This reference guide covers both our Analyze and Finalize APIs.
Note: The LinkSquares API Swagger documentation is OAS 3.0 compliant.
For a quick and interactive way to explore our API endpoints, you can also visit our LinkSquares API Reference page.
Process
To download the LinkSquares API JSON and upload it into Swagger:
1. Log in to the LinkSquares web app using the credentials associated with the LinkSquares API key.
2. Go to Settings from the app selector.
3. Select API Keys.
4. Select OpenAPI Specification from the Learn About LinkSquares API drop-down.
The LinkSquares API JSON will save to your downloads folder.
5. Navigate to https://editor-next.swagger.io/.
6. Click File > Import File.
7. Select the LinkSquares_OpenAPI.json file from your downloads folder and click Open.
The JSON file will be organized into collapsable sections for each Finalize and Analyze API endpoint. Underneath the endpoint sections are schema sections, which outline each field in the API endpoints.
To access the LinkSquares API and SDK Reference Guide, please download the file below and upload it to editor-next.swagger.io. Please note that this guide covers both the LinkSquares Analyze API and the LinkSquares Finalize API.