https://github.com/linksgpt/url-shortener-sdk-python
Official Python SDK for interacting with LinksGPT URL Shortener APIs.
https://github.com/linksgpt/url-shortener-sdk-python
seo-tools short-link short-url url-shortener web-tools
Last synced: 6 months ago
JSON representation
Official Python SDK for interacting with LinksGPT URL Shortener APIs.
- Host: GitHub
- URL: https://github.com/linksgpt/url-shortener-sdk-python
- Owner: LinksGPT
- License: mit
- Created: 2024-11-16T10:33:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-16T12:18:42.000Z (over 1 year ago)
- Last Synced: 2025-09-19T21:34:12.905Z (9 months ago)
- Topics: seo-tools, short-link, short-url, url-shortener, web-tools
- Language: Python
- Homepage: https://www.linksgpt.com/
- Size: 38.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LinksGPT URL Shortener Python SDK
[LinksGPT](https://www.linksgpt.com/) URL Shortener SDK, provides an easy way to interact with the [LinksGPT API](https://dev.linksgpt.com/docs/links/create), enabling developers to build applications that leverage the power of LinksGPT's features.
[LinksGPT](https://www.linksgpt.com/) is a professional link management platform for custom short urls, brand building and conversion optimization. It offers intelligent URL shortening and expansion, custom domains, team roles, customizable QR codes, tracking and AI-based in-depth analytics, deep linking, openAPI and enhanced link security. Powered by AI, it provides intelligent insights and recommendations based on user behavior and click patterns, support data-driven brand strategies and marketing decisions.
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import swagger_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import swagger_client
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyAuth
configuration = swagger_client.Configuration()
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.V1DomainsApi(swagger_client.ApiClient(configuration))
workspace = 'workspace_example' # str | Your workspace id, if you do not specify the workspace context, the default workspace (your main workspace) will be used. If apikey is used as the authentication mode, you do not need to set this parameter. (optional)
try:
# List your domains
api_response = api_instance.list_domains(workspace=workspace)
pprint(api_response)
except ApiException as e:
print("Exception when calling V1DomainsApi->list_domains: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://app.linksgpt.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*V1DomainsApi* | [**list_domains**](docs/V1DomainsApi.md#list_domains) | **GET** /api/v1/domains | List your domains
*V1LinksApi* | [**create_link**](docs/V1LinksApi.md#create_link) | **POST** /api/v1/links | Create a new link
*V1LinksApi* | [**delete_link**](docs/V1LinksApi.md#delete_link) | **DELETE** /api/v1/links/{id} | Delete a link
*V1LinksApi* | [**get_link_by_id**](docs/V1LinksApi.md#get_link_by_id) | **GET** /api/v1/links/{id} | Get a link
*V1LinksApi* | [**list_links**](docs/V1LinksApi.md#list_links) | **GET** /api/v1/links | List links
*V1LinksApi* | [**list_tags**](docs/V1LinksApi.md#list_tags) | **GET** /api/v1/links/tags | List tags
*V1LinksApi* | [**update_link**](docs/V1LinksApi.md#update_link) | **PUT** /api/v1/links/{id} | Update a link
*V1LinksApi* | [**update_link_tags**](docs/V1LinksApi.md#update_link_tags) | **PUT** /api/v1/links/{id}/tags | Update the tags
*V1UsersApi* | [**get_account_details**](docs/V1UsersApi.md#get_account_details) | **GET** /api/v1/users/me | Get account details
## Documentation For Models
- [InlineResponse200](docs/InlineResponse200.md)
- [InlineResponse2001](docs/InlineResponse2001.md)
- [InlineResponse2002](docs/InlineResponse2002.md)
- [InlineResponse2003](docs/InlineResponse2003.md)
- [InlineResponse2004](docs/InlineResponse2004.md)
- [InlineResponse2004Data](docs/InlineResponse2004Data.md)
- [InlineResponse2005](docs/InlineResponse2005.md)
- [InlineResponse400](docs/InlineResponse400.md)
- [V1CreateLinkRequest](docs/V1CreateLinkRequest.md)
- [V1DomainResource](docs/V1DomainResource.md)
- [V1DomainResourceProvider](docs/V1DomainResourceProvider.md)
- [V1LinkResource](docs/V1LinkResource.md)
- [V1LinkResourceUtm](docs/V1LinkResourceUtm.md)
- [V1ReTagRequest](docs/V1ReTagRequest.md)
- [V1UpdateLinkRequest](docs/V1UpdateLinkRequest.md)
- [V1UserResource](docs/V1UserResource.md)
## Documentation For Authorization
## ApiKeyAuth
- **Type**: API key
- **API key parameter name**: apiKey
- **Location**: HTTP header
## Author
service@linksgpt.com