urlr@3.3.0
This SDK is automatically generated with the OpenAPI Generator project.
- API version: 2.1.1
- Package version: 3.3.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit https://urlr.me/en
Installation & Usage
Requirements
Python 3.10+
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
api_key = os.getenv("URLR_API_KEY") # to be defined on your side
configuration = urlr.Configuration()
configuration.api_key['ApiKeyAuth'] = api_key
# Create a link
with urlr.ApiClient(configuration) as api_client:
links_api = urlr.LinksApi(api_client)
link_create_request = urlr.LinkCreateRequest(
url="",
)
try:
link = links_api.link_create(link_create_request=link_create_request)
except Exception as e:
print("Exception when calling LinksApi->link_create: %s\n" % e)
Complete examples can be found in the docs directory of the client repository.
API Endpoints
All URIs are relative to https://urlr.me/api/v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DomainsApi | domain_create | POST /domains | Create a domain |
| DomainsApi | domain_get | GET /domains/{domain_id} | Get a domain |
| DomainsApi | domain_list | GET /domains | List domains |
| FoldersApi | folder_create | POST /folders | Create a folder |
| FoldersApi | folder_get | GET /folders/{folder_id} | Get a folder |
| FoldersApi | folder_list | GET /folders | List folders |
| LinksApi | link_create | POST /links | Create a link |
| LinksApi | link_delete | DELETE /links/{link_id} | Delete a link |
| LinksApi | link_edit | PATCH /links/{link_id} | Edit a link |
| LinksApi | link_get | GET /links/{link_id} | Get a link |
| LinksApi | link_list | GET /links | List links |
| QRCodesApi | qrcode_create | POST /qrcodes | Create a QR Code |
| StatisticsApi | statistic_get | GET /statistics | Get statistics |
Models
- Domain
- DomainCreate409Response
- DomainCreate429Response
- DomainCreateRequest
- DomainGet401Response
- DomainGet404Response
- DomainGet422Response
- DomainGet500Response
- DomainList200Response
- Folder
- FolderCreateRequest
- FolderList200Response
- Link
- LinkBaseRequest
- LinkBaseRequestMetatag
- LinkBaseRequestQrcode
- LinkCreateRequest
- LinkEditRequest
- LinkGeolinksInner
- LinkGeolinksInnerConditionsInner
- LinkList200Response
- LinkMetatag
- LinkQrcode
- LinkTagsInner
- LinkUtm
- QrcodeCreateRequest
- QrcodeCreateRequestOneOf
- QrcodeCreateRequestOneOf1
- StatisticGet200Response
Authorization
Authentication schemes defined for the API:
ApiKeyAuth
- Type: API key
- API key parameter name: X-API-KEY
- Location: HTTP header
Get help / support
Please contact contact@urlr.me and we can take more direct action toward finding a solution.
Metadata
Release files for urlr 3.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| urlr-3.3.0.tar.gz | 45.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| urlr-3.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 134.0 kB
Release files / urlr-3.3.0.tar.gz
| Download URL | urlr-3.3.0.tar.gz |
|---|---|
| Size | 45.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dffbc2791cc10001c60c736f82a8255fd64539e190955725b925f79578d634e6
|
|
BLAKE2b-256 checksum How to use checksums |
9501057ea472ea744fd8ce899628e44ad2f1dd0240fba97cdf14be4a677342b5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / urlr-3.3.0-py3-none-any.whl
| Download URL | urlr-3.3.0-py3-none-any.whl |
|---|---|
| Size | 89.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c8b58409fca9b43e6ff0d406dda4cc6eb54287be601ce90242112734c674cf84
|
|
BLAKE2b-256 checksum How to use checksums |
15b942812e53be0dae64e3c8ef5f885dc3d6268841546040c814e8af2b87db3f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Security for urlr 3.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.