Welcome to the Wurl API.

This guide is a great way to get started with the Wurl API. It is designed to get you to your first authenticated response quickly so you can start developing your application.

If you already have a developed an application and want in-depth information about request or response formats, you probably want to check out the Reference Guide.

To start using the Wurl API, follow these steps:

Register as a Developer

Please email support to request a developer account.

Create an Application

Each developer using the Wurl API associates his or her own application with a registered Wurl Application.

Once you have confirmed your developer account, create your Wurl Application by visiting api.wurl.com and sign-in with your Wurl Developer credentials. Choose "New Application".

When you create your Wurl Application, you assign it an "Application Name" of your choosing and specify an "oAuth Callback URL". To integrate with the Wurl API via oAuth see our Authentication Guide. For test purposes, you can use the following url:

urn:ietf:wg:oauth:2.0:oob

Create an Access Token

Once your application has been created, click the link labeled Create Access Token, and you will be directed to your Authorized Applications page. Here you will see your newly created Wurl Application and your Access Token. This access token is tied to your login and application. It should be used only for development purposes and not shared amongst all your users.

An Access Token is required for all API requests made by your Application. API requests without an access token will receive a 401 - Unauthorized response code.

In your code, you can specify your access token via the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

If you are unable to set request headers, you can also provide an access_token query parameter:

https://api.wurl.com/api?access_token=YOUR_ACCESS_TOKEN

The Wurl API follows the tenets of a Hypermedia API. Therefore, you should avoid constructing URLs. We recommend that you specify the Authorization request header so that you can use the URLs the API provides without having to constantly append the access_token query parameter.

Make your first API Request

You’re now ready to make your first API request. You can make an api request with curl (replace YOUR_ACCESS_TOKEN with your Access Token):

$ curl -H 'Accept: application/json' -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' https://api.wurl.com/api

{
 "links": [
  {
   "rel": [
    "self"
   ],
   "href": "https://api.wurl.com/api"
  },
  {
   "rel": [
    "bundles"
   ],
   "href": "https://api.wurl.com/api/bundles"
  },
.....

Or you can make the request via a browser by passing the access token query parameter:

https://api.wurl.com/api?format=json&access_token=YOUR_ACCESS_TOKEN

That's it!

To learn about the Wurl API and the content in the Wurl Index, we recommend you create a simple "Browse" app. See the Packages guide for tips.

A tool like jshon allows you to pretty print and query json output from curl as shown above.

A browser extension like JSONView or Postman makes working with JSON responses much easier on the eyes.

See our reference documentation for more details. If you have any questions, visit our support site or send an email to Wurl Developer Support.

Welcome to the Wurl API.

This guide is a great way to get started with the Wurl API. It is designed to get you to your first authenticated response quickly so you can start developing your application.

If you already have a developed an application and want in-depth information about request or response formats, you probably want to check out the Reference Guide.

To start using the Wurl API, follow these steps:

Register as a Developer

Please email support to request a developer account.

Create an Application

Each developer using the Wurl API associates his or her own application with a registered Wurl Application.

Once you have confirmed your developer account, create your Wurl Application by visiting api.wurl.com and sign-in with your Wurl Developer credentials. Choose "New Application".

When you create your Wurl Application, you assign it an "Application Name" of your choosing and specify an "oAuth Callback URL". To integrate with the Wurl API via oAuth see our Authentication Guide. For test purposes, you can use the following url:

urn:ietf:wg:oauth:2.0:oob

Create an Access Token

Once your application has been created, click the link labeled Create Access Token, and you will be directed to your Authorized Applications page. Here you will see your newly created Wurl Application and your Access Token. This access token is tied to your login and application. It should be used only for development purposes and not shared amongst all your users.

An Access Token is required for all API requests made by your Application. API requests without an access token will receive a 401 - Unauthorized response code.

In your code, you can specify your access token via the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

If you are unable to set request headers, you can also provide an access_token query parameter:

https://api.wurl.com/api?access_token=YOUR_ACCESS_TOKEN

The Wurl API follows the tenets of a Hypermedia API. Therefore, you should avoid constructing URLs. We recommend that you specify the Authorization request header so that you can use the URLs the API provides without having to constantly append the access_token query parameter.

Make your first API Request

You’re now ready to make your first API request. You can make an api request with curl (replace YOUR_ACCESS_TOKEN with your Access Token):

$ curl -H 'Accept: application/json' -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' https://api.wurl.com/api

{
 "links": [
  {
   "rel": [
    "self"
   ],
   "href": "https://api.wurl.com/api"
  },
  {
   "rel": [
    "bundles"
   ],
   "href": "https://api.wurl.com/api/bundles"
  },
.....

Or you can make the request via a browser by passing the access token query parameter:

https://api.wurl.com/api?format=json&access_token=YOUR_ACCESS_TOKEN

That's it!

To learn about the Wurl API and the content in the Wurl Index, we recommend you create a simple "Browse" app. See the Packages guide for tips.

A tool like jshon allows you to pretty print and query json output from curl as shown above.

A browser extension like JSONView or Postman makes working with JSON responses much easier on the eyes.

See our reference documentation for more details. If you have any questions, visit our support site or send an email to Wurl Developer Support.