urlr 2.13.0

Python client for URLR

urlr@2.13.0

This SDK is automatically generated with the OpenAPI Generator project.

• API version: 1.12
• Package version: 2.13.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit https://urlr.me/en

Installation & Usage

Requirements

Python 3.9+

pip install

pip install urlr

Then import the package:

import urlr

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import urlr

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import os
import urlr
from urlr.rest import ApiException

username = os.getenv("URLR_API_USERNAME")  # to be defined on your side
password = os.getenv("URLR_API_PASSWORD")  # to be defined on your side


# Access Tokens

configuration = urlr.Configuration()

with urlr.ApiClient(configuration) as api_client:
    access_token_api = urlr.AccessTokensApi(api_client)

    create_access_token_request = urlr.CreateAccessTokenRequest(
        username=username,
        password=password,
    )

    try:
        api_response = access_token_api.create_access_token(
            create_access_token_request=create_access_token_request)
    except ApiException as e:
        print("Exception when calling AccessTokensApi->create_access_token: %s\n" % e)
        quit()

configuration.access_token = api_response.token

# Create a link

with urlr.ApiClient(configuration) as api_client:
    links_api = urlr.LinksApi(api_client)
    create_link_request = urlr.CreateLinkRequest(
        url="",
        team_id=""
    )

    try:
        link = links_api.create_link(
            create_link_request=create_link_request)
    except Exception as e:
        print("Exception when calling LinksApi->create_link: %s\n" % e)

A complete example is available here.

API Endpoints

All URIs are relative to https://urlr.me/api/v1

Class	Method	HTTP request	Description
AccessTokensApi	create_access_token	POST /access_tokens/create	Get an access token
AccessTokensApi	refresh_access_token	POST /access_tokens/refresh	Refresh an access token
DomainsApi	create_domain	POST /domains/create	Create a domain
FoldersApi	create_folder	POST /folders/create	Create a folder
FoldersApi	get_folders	GET /folders/{team_id}	Get folders of workspace
LinksApi	create_link	POST /links/create	Create a link
LinksApi	edit_link	PATCH /links/{link_id}	Edit a link
LinksApi	get_link	GET /links/{link_id}	Get a link
LinksApi	list_links	GET /links	List links
QRCodesApi	create_qr_code	POST /qrcodes/create	Create a QR Code
StatisticsApi	get_statistics	POST /statistics	Get statistics of a link
WorkspacesApi	get_teams	GET /teams	Get workspaces of user

Models

• BaseLinkRequest
• BaseLinkRequestMetatag
• BaseLinkRequestQrcode
• CreateAccessToken200Response
• CreateAccessToken401Response
• CreateAccessTokenRequest
• CreateDomain200Response
• CreateDomainRequest
• CreateFolder200Response
• CreateFolder409Response
• CreateFolderRequest
• CreateLink429Response
• CreateLinkRequest
• CreateQrCodeRequest
• CreateQrCodeRequestOneOf
• CreateQrCodeRequestOneOf1
• EditLink500Response
• EditLinkRequest
• GetFolders200Response
• GetFolders200ResponseFoldersInner
• GetLink401Response
• GetLink404Response
• GetLink422Response
• GetStatistics200Response
• GetStatisticsRequest
• GetTeams200Response
• GetTeams200ResponseTeamsInner
• Link
• LinkGeolinksInner
• LinkGeolinksInnerConditionsInner
• LinkMetatag
• LinkQrcode
• LinkTagsInner
• LinkUtm
• ListLinks200Response
• RefreshAccessToken401Response
• RefreshAccessTokenRequest

Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Get help / support

Please contact [e-mail] and we can take more direct action toward finding a solution.