urlr / urlr-php
PHP client for URLR
2.4.0
2024-10-09 09:28 UTC
Requires
- php: ^8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.4.5
- guzzlehttp/psr7: ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- overtrue/phplint: ^9.0
- phpunit/phpunit: ^9.0
README
This SDK is automatically generated with the OpenAPI Generator project.
- API version: 1.3
- Package version: 2.4.0
- Build package: urlr/urlr-php
For more information, please visit https://urlr.me/en
Installation & Usage
Requirements
PHP 8.1 and later.
Composer
You can install the bindings via Composer. Run the following command:
composer require urlr/urlr-php
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/URLR/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Access Tokens $accessTokensApi = new URLR\Api\AccessTokensApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client() ); $accessTokensRequest = new \URLR\Model\AccessTokensRequest([ 'username' => '', 'password' => '', ]); // \URLR\Model\AccessTokensRequest | Your credentials try { $token = $accessTokensApi->createAccessToken($accessTokensRequest)->getToken(); } catch (Exception $e) { echo 'Exception when calling AccessTokensApi->createAccessToken: ', $e->getMessage(), PHP_EOL; exit; } $config = URLR\Configuration::getDefaultConfiguration()->setAccessToken($token); // Link shortening $linksApi = new URLR\Api\LinksApi(null, $config); $createLinkRequest = new \URLR\Model\CreateLinkRequest([ 'url' => '', 'teamId' => '' ]); // \URLR\Model\CreateLinkRequest | Infos of the link to shorten try { $result = $apiInstance->createLink($createLinkRequest); print_r($result); } catch (Exception $e) { echo 'Exception when calling LinksApi->createLink: ', $e->getMessage(), PHP_EOL; }
A complete example is available here.
API Endpoints
All URIs are relative to https://urlr.me/api/v1
Models
- CreateAccessToken200Response
- CreateAccessToken401Response
- CreateAccessTokenRequest
- CreateLink429Response
- CreateLink500Response
- CreateLinkRequest
- CreateLinkRequestMetatag
- CreateLinkRequestQrcode
- CreateQrCodeRequest
- CreateQrCodeRequestOneOf
- CreateQrCodeRequestOneOf1
- GetFolders200Response
- GetFolders200ResponseFoldersInner
- GetLink200Response
- GetLink200ResponseGeolinksInner
- GetLink200ResponseMetatag
- GetLink200ResponseQrcode
- GetLink401Response
- GetLink404Response
- GetLink422Response
- GetStatistics200Response
- GetStatisticsRequest
- GetTeams200Response
- GetTeams200ResponseTeamsInner
- RefreshAccessToken401Response
- RefreshAccessTokenRequest
Authorization
bearerAuth
- Type: Bearer authentication (JWT)
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Get help / support
Please contact contact@urlr.me and we can take more direct action toward finding a solution.