addadd-thickarrow-downaxebreadcrumb dividercameracc-compulsarychatclosecontactdata-usersdebugdevelopersdismissdocumentserrorglossaryinfolinkpublisherssearchselect-dropdownsuccesstableswarning

Developers

APIs to manage your site, query data and build new products and services.

  1. Home
  2. Developers
  3. Publisher Admin API
  4. License API

License API

The Koordinates License API provides access to licences that can be applied to layers, tables, sources and documents. It also provides access to the Creative Commons API by property lookup, as well as custom built-in licences.

Licences

GET /licenses/
List licences

Response 200

Headers

Content-Type: application/json

Body

[
    {
        "id": 9, 
        "title": "Creative Commons Attribution 3.0 New Zealand", 
        "type": "cc-by", 
        "jurisdiction": "nz", 
        "version": "3.0", 
        "url": "http://koordinates.com/services/api/v1/licenses/9/", 
        "url_html": "http://koordinates.com/license/attribution-3-0-new-zealand/"
    },
    ...
]

Licence detail

GET /licenses/{id}/
Get licence detail

Response 200

Headers

Content-Type: application/json

Body

{
    "id": 9, 
    "title": "Creative Commons Attribution 3.0 New Zealand", 
    "type": "cc-by", 
    "jurisdiction": "nz", 
    "version": "3.0", 
    "url": "http://koordinates.com/services/api/v1/licenses/9/", 
    "url_html": "http://koordinates.com/license/attribution-3-0-new-zealand/"
}

Creative Commons Licence lookup

GET /licenses/{slug}/{jurisdiction}/
Returns CC licence for given attributes

Parameters

  • slug: string (required). The slug is a string that defines the type of Creative Commons licence. It must start with cc-by and can optionally contain nc (non-commercial), sa (share-alike), nd (no derivatives) terms, seperated by hyphens. Note that a CC licence cannot be both sa and nd. Example: cc-by-sa
  • jurisdiction: string (optional). The jurisdiction for a ported Creative Commons licence. Example: nz

Response 200

Headers

Content-Type: application/json

Body

{
    "id": 12, 
    "title": "Creative Commons Attribution-Share Alike 3.0 New Zealand", 
    "type": "cc-by-sa", 
    "jurisdiction": "nz", 
    "version": "3.0", 
    "url": "http://koordinates.com/services/api/v1/licenses/12/", 
    "url_html": "http://koordinates.com/license/attribution-share-alike-3-0-new-zealand/"
}