Polr Restful API: Provide an API for the Polr URL shortener service

Recommend this page to a friend!

Download

Info

Documentation

Files

Install with Composer

Download

Reputation

Support forum

Blog

Links

Ratings				Unique User Downloads		Download Rankings
Not yet rated by the users				Total: 58		All time: 10,535 This week: 524

Version		License		PHP version		Categories
`polr-api` 2.0.0		GNU General Publi...		5		HTTP, PHP 5, Web services

Description

Author

Thierry Feuzeu

This package provides an API for the Polr URL shortener service.

It provides several end points for the API URLs that give access to different features of the shortener.

Currently the the API gives access to all Polr users, links and stats features, except user creation and deletion, password change, and link redirection.

Thierry Feuzeu

Performance

Level

Name:	Thierry Feuzeu `<contact>`
Classes:	13 packages by Thierry Feuzeu
Country:	Cameroon
Age:	48
All time rank:	2171	1 in Cameroon
Week rank:	180	1 in Cameroon

Level 2

Innovation award

Nominee: 1x

Documentation

Polr API

A Restful API for the Polr URL Shortener

Features

This package gives access to all Polr features through a Restful API, excepted the following.

User creation and deletion.
Password change.
Link redirection.

Installation

Add the Github repository and package to the composer.json file of your Polr installation, and run composer update.

{
    "repositories": [
        {
            "type": "git",
            "url": "https://github.com/lagdo/polr-api"
        }
    ],
    "require": {
        "lagdo/polr-api": "dev-master"
    }
}

$app->register(\Lagdo\Polr\Api\PolrApiServiceProvider::class);

Documentation

The API endpoints are documented here. The documentation is generated with API Doc.

Known issues

Sometimes the requests to the API return with errors due to CSRF verification failure. That's because Polr has disabled CSRF verification only for its own API endpoints.

This API endpoints then need to be also added in the app/Http/Middleware\VerifyCsrfToken.php file.

    public function handle($request, \Closure $next) {
        if ($request->is('api/v/action/') ||
            $request->is('api/v/data/') ||
            $request->is('api/v/links/') ||
            $request->is('api/v/users/') ||
            $request->is('api/v/stats/')) {
            // Exclude public API from CSRF protection
            // but do not exclude private API endpoints
            return $next($request);
        }

        return parent::handle($request, $next);
    }

Details

Polr API v2.0.0

Restful API for the Polr URL Shortener

Links - Delete a link - Get Admin Links - Get User Links - Lookup Link - Shorten a link - Update a link
Stats - Get Link Stats - Get Stats
Users - Change API Settings - Generate Key - Get a User - Get Users - Update a user

Links

Delete a link

Delete the link with the given ending.

DELETE /links/:ending

Parameter Parameters

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | key | String | The user API key.|

Success 200

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | message | String | The response message.| | settings | Object | The Polr instance config options.|

Error 401

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | AccessDenied | Object | The user does not have permission to delete links.|

Error 404

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | NotFound | Object | Unable to find a link with the given ending.|

Get Admin Links

Fetch a paginated list of links. The input parameters are those of the Datatables library.

GET /links

Parameter Parameters

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | draw | Integer | optionalThe draw option.| | columns | Object | optionalThe table columns.| | order | Object | optionalThe data ordering.| | start | Integer | optionalThe data offset.| | length | Integer | optionalThe data count.| | search | Object | optionalThe search options.|

Success 200

Error 401

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | AccessDenied | Object | The user does not have permission to list links.|

Get User Links

Fetch a paginated list of links. The input parameters are those of the Datatables library.

GET /users/me/links

Parameter Parameters

Success 200

Error 401

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | AccessDenied | Object | The user does not have permission to list links.|

Lookup Link

Returns

GET /links/:ending

Parameter Parameters

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | key | String | The user API key.| | secret | String | optionalThe link secret.|

Success 200

Error 404

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | NotFound | Object | Unable to find a link with the given ending.|

Error 401

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | AccessDenied | Object | Invalid URL code given for a secret URL.|

Error 400

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | MissingParameters | Object | There is a missing or invalid parameter.|

Shorten a link

Create a shortened URL for a given link

POST /links

Parameter Parameters

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | key | String | The user API key.| | url | String | The link to shorten.| | ending | String | optionalA custom ending for the link.| | secret | String | optionalCreate a secret link or not.| | ip | String | optionalThe IP address the request came from.|

Success 200

Error 400

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | CreationError | Object | An error occurs while shortening the link.| | MissingParameters | Object | There is a missing or invalid parameter.|

Update a link

Update the link with the given ending.

PUT /links/:ending

Parameter Parameters

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | key | String | The user API key.| | url | String | optionalThe new URL.| | status | String | optionalThe status change: enable, disable or toggle.|

Success 200

Error 401

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | AccessDenied | Object | The user does not have permission to edit the link.|

Error 404

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | NotFound | Object | Unable to find a link with the given ending.|

Error 400

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | MissingParameters | Object | There is a missing or invalid parameter.|

Stats

Get Link Stats

Fetch stats of a given type for a single link.

GET /links/:ending/stats

Parameter Parameters

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | key | String | The user API key.| | type | String | The type of stats to fetch.| | ending | String | The short URL id of the link.| | left_bound | String | The start date.| | right_bound | String | The end date.|

Success 200

Error 401

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | AccessDenied | Object | The user does not have permission to view stats.|

Error 400

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | AnalyticsError | Object | An error occurs while fetching stats from the database.| | MissingParameters | Object | There is a missing or invalid parameter.|

Get Stats

Fetch stats of a given type.

GET /stats

Parameter Parameters

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | key | String | The user API key.| | type | String | The type of stats to fetch.| | left_bound | String | The start date.| | right_bound | String | The end date.|

Success 200

Error 401

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | AccessDenied | Object | The user does not have permission to view stats.|

Error 400

Users

Change API Settings

Change the API Settings of the user with the given id.

PUT /users/:id/api

Parameter Parameters

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | key | String | The user API key.| | quota | String | optionalThe new API quota.| | status | String | optionalThe API access change: enable, disable or toggle.|

Success 200

Error 401

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | AccessDenied | Object | The user does not have permission to edit the user.|

Error 404

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | NotFound | Object | Unable to find a user with the given id.|

Error 400

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | MissingParameters | Object | There is a missing or invalid parameter.|

Generate Key

Generate a new API access key for the user with the given id.

POST /users/:id/api

Parameter Parameters

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | key | String | The user API key.|

Success 200

Error 401

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | AccessDenied | Object | The user does not have permission to edit the user.|

Error 404

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | NotFound | Object | Unable to find a user with the given id.|

Error 400

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | MissingParameters | Object | There is a missing or invalid parameter.|

Get a User

Get the user with the given id

GET /users/:id

Parameter Parameters

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | key | String | The user API key.|

Success 200

Error 401

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | AccessDenied | Object | The user does not have permission to get users.|

Error 404

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | NotFound | Object | Unable to find a user with the given id.|

Error 400

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | MissingParameters | Object | There is a missing or invalid parameter.|

Get Users

Fetch a paginated list of users. The input parameters are those of the Datatables library.

GET /users

Parameter Parameters

Success 200

Error 401

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | AccessDenied | Object | The user does not have permission to list users.|

Update a user

Update the user with the given id.

PUT /users/:id

Parameter Parameters

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | key | String | The user API key.| | role | String | optionalThe new role.| | status | String | optionalThe user status change: enable, disable or toggle.|

Success 200

Error 401

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | AccessDenied | Object | The user does not have permission to edit the user.|

Error 404

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | NotFound | Object | Unable to find a user with the given id.|

Error 400

| Name | Type | Description | |:---------|:-----------|:--------------------------------------| | MissingParameters | Object | There is a missing or invalid parameter.|

Files (16)

File	Role	Description
`docs` (1 file)
`src` (1 file, 2 directories)
`tests` (2 files)
`apidoc.json`	Data	Auxiliary data
`composer.json`	Data	Auxiliary data
`LICENSE`	Lic.	License text
`README.md`	Doc.	Documentation

Files (16)

docs

File	Role	Description
`api.md`	Data	Auxiliary data

Files (16)

src

File	Role	Description
`Helpers` (3 files)
`Http` (1 file, 2 directories)
`PolrApiServiceProvider.php`	Class	Class source

Files (16)

src

Helpers

File	Role	Description
`ResponseHelper.php`	Class	Class source
`StatsHelper.php`	Class	Class source
`UserHelper.php`	Class	Class source

Files (16)

src

Http

File	Role	Description
`Controllers` (3 files)
`Middleware` (1 file)
`routes.php`	Example	Example script

Files (16)

src

Http

Controllers

File	Role	Description
`LinkController.php`	Class	Class source
`StatsController.php`	Class	Class source
`UserController.php`	Class	Class source

Files (16)

src

Http

Middleware

File	Role	Description
`RestApiMiddleware.php`	Class	Class source

Files (16)

tests

File	Role	Description
`ExampleTest.php`	Class	Class source
`TestCase.php`	Class	Class source

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.

Install with Composer

	polr-api-2017-11-04.zip 21KB
	polr-api-2017-11-04.tar.gz 16KB
	Install with Composer

Version Control

Reuses

Unique User Downloads

Download Rankings

100%

Total:	58
This week:	0

All time:	10,535
This week:	524

Applications that use this package

No pages of applications that use this class were specified.

If you know an application of this package, send a message to the author to add a link here.

Other classes that need this package

Class	Why it is needed	Dependency
Polr Admin Dashboard	Needs to be installed on managed Polr instances	Required

About us

Advertise on this site

For more information send a message to info at phpclasses dot org.