Alex/polr
1
0
Fork 0
mirror of https://github.com/cydrobolt/polr.git synced 2024-11-08 19:22:29 +01:00
Code Issues Releases Wiki Activity

Updated Polr Self Hosted API Documentation (markdown)

Chaoyi Zha 2015-10-29 22:01:39 -04:00
parent 9fa511e24c
commit 701b07cd0a
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Polr-Self-Hosted-API-Documentation.md

@ -20,7 +20,7 @@ The `shorten` action takes a single argument: `url`. This is the URL to
shorten. The API will return with a plain text response containing a
shortened URL.
Example: GET `http://polr.cf/api.php?apikey=key&action=shorten&url=http://google.com`
Example: GET `http://polr.me/api.php?apikey=key&action=shorten&url=http://google.com`
Remember that the `url` argument must be urlencoded (unless it is passed as a
POST parameter).
@ -30,14 +30,14 @@ The `lookup` action takes a single argument: `url`. This is the URL to
lookup. If it exists, the API will return with the destination of that URL. If
it does not exist, the API will return with the status code 404 (Not Found).
Example: GET `http://polr.cf/api.php?apikey=hunter2&action=lookup&url=3`
Example: GET `http://polr.me/api.php?apikey=hunter2&action=lookup&url=3`
Remember that the `url` argument must be urlencoded (unless it is passed as a
POST parameter).
### Response
The API will respond in plain text. For `lookup` and `shorten`, it will reply with a URL, e.g `http://polr.cf/123` or `http://alookedupurl.com` .
The API will respond in plain text. For `lookup` and `shorten`, it will reply with a URL, e.g `http://polr.me/123` or `http://alookedupurl.com` .
### Code Examples