Api Root

The API Root resource has a special purpose as the main API entry point through which developers access URLs for all other API requests.

Request URL

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

Properties in the API Response

Name Type Description
none

Entities in the API Response

none

Links in the API Response

Name Description
channels The url to the channels index resource.
self The canonical or preferred url to a resource.
search The url to the search resource.
series The url to the series resource.
me The url to the current user resource.
schema The url to a resource's json-schema.

Sample API Response

{
  "rel": [
    "urn:x-resource:schema:https://api.wurl.com/schemas/root.json"
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api"
    },
    {
      "rel": [
        "urn:x-resource:name:bundles"
      ],
      "href": "https://api.wurl.com/api/bundles",
      "class": [
        "bundles"
      ]
    },
    {
      "rel": [
        "urn:x-resource:name:me"
      ],
      "href": "https://api.wurl.com/api/users/me",
      "class": [
        "user"
      ]
    },
    {
      "rel": [
        "urn:x-resource:name:packages"
      ],
      "href": "https://api.wurl.com/api/packages",
      "class": [
        "packages"
      ]
    },
    {
      "rel": [
        "urn:x-resource:name:series"
      ],
      "href": "https://api.wurl.com/api/series",
      "class": [
        "series"
      ]
    },
    {
      "rel": [
        "urn:x-resource:name:search",
        "template"
      ],
      "href": "https://api.wurl.com/api/search{?q}",
      "class": [
        "search"
      ]
    }
  ]
}

Api Root

The API Root resource has a special purpose as the main API entry point through which developers access URLs for all other API requests.

Request URL

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

Properties in the API Response

Name Type Description
none

Entities in the API Response

none

Links in the API Response

Name Description
channels The url to the channels index resource.
self The canonical or preferred url to a resource.
search The url to the search resource.
series The url to the series resource.
me The url to the current user resource.
schema The url to a resource's json-schema.

Sample API Response

{
  "rel": [
    "urn:x-resource:schema:https://api.wurl.com/schemas/root.json"
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api"
    },
    {
      "rel": [
        "urn:x-resource:name:bundles"
      ],
      "href": "https://api.wurl.com/api/bundles",
      "class": [
        "bundles"
      ]
    },
    {
      "rel": [
        "urn:x-resource:name:me"
      ],
      "href": "https://api.wurl.com/api/users/me",
      "class": [
        "user"
      ]
    },
    {
      "rel": [
        "urn:x-resource:name:packages"
      ],
      "href": "https://api.wurl.com/api/packages",
      "class": [
        "packages"
      ]
    },
    {
      "rel": [
        "urn:x-resource:name:series"
      ],
      "href": "https://api.wurl.com/api/series",
      "class": [
        "series"
      ]
    },
    {
      "rel": [
        "urn:x-resource:name:search",
        "template"
      ],
      "href": "https://api.wurl.com/api/search{?q}",
      "class": [
        "search"
      ]
    }
  ]
}