These are programmatic interfaces to the AppURL.org directory.
/transform/{url}
Returns the native URL associated with the requested http://
or https://
URL.
{url}
http://
or https://
. http://
is implied if these prefixes are omitted.webUrl
url
(this is just url
itself, possibly with a prepended http://
).nativeUrl
url
. This transformation is made after consulting the appropriate appurl.json file.http://api.appurl.org/transform/yelp.com/search?find_desc=chipotle
Response
{ "webUrl": "http://yelp.com/search?find_desc=chipotle", "nativeUrl": "yelp:///search?terms=chipotle" }
/app/{url}
Returns all information about an app associated with the requested URL.
{url}
http://
or https://
. http://
is implied if these prefixes are omitted.manifest
manifestUrl
timestamp
http://api.appurl.org/app?webPrefix=grid6.us
Response
{ "manifest": { "developer": "AppURL", "editions": [ { "downloadUrl": "http://appurl.org/static/pkg/grid6.apk", "platform": "android" }, { "downloadUrl": "http://appurl.org/static/pkg/grid6.xap", "platform": "wp8" } ], "email": "contact@appurl.org", "homepage": "http://grid6.us/grid.html", "iconUrl": "http://appurl.org/static/grid6logo.png", "name": "Grid6", "nativePrefix": "grid6.us:/", "transforms": [ { "description": "This URL specifies the light grid formations.", "native": "{state}", "nativeDelim": "/", "title": "Grid6 Formation", "web": "{state}", "webDelim": "/" } ], "webPrefix": "grid6.us/" }, "manifestUrl": "http://grid6.us/appurl.json", "rc": 0, "timestamp": "2013-03-14T14:32:17" }
/add-app/
Tells Appurl.org to read an appurl.json
file at the specified URL. Once read, the appurl.json
file will be used to perform web-to-native URL transformations.
manifestUrl
application/x-www-form-urlencoded
.msg
"appurl.json file successfully read."
on success, and an error message on failure.http://api.appurl.org/add-app
manifestUrl=http://grid6.us/appurl.json
Content-Type: application/x-www-form-urlencoded
{ "msg": "appurl.json file successfully read.", "rc": 0 }
All API responses contain a response code key, rc
:
rc
of 0
rc
, and a string msg
that describes the errorReturn code values have the following meanings:
1
: App Not Found2
: Could Not Match Transformation3
: Unable to verify appurl.json File4
: Invalid appurl.json File5
: Request Missing Information6
: Request Contains Invalid Input7
: Incorrect Content-Type8
: Does Not Exist9
: Unexpected Error