/v2/license

GET

Parameter Options
token Your access token
license_key The license key from a track (Also called RADKey™)
receipt A receipt number

Usage

Without specifying an license_key or receipt parameter, you will receive a list of valid licenses for your portal, including the full license text and the available catalog_ids for each license.

{
  'valid_license_types' : [
    {
      'version' : 1,
      'license_type' : 1,
      'rights' : brief statement of rights,
      'purpose' : brief statement of purpose,
      'region' : description of regions,
      'term' : brief statement of term of use,
      'text' : full license text,
      'catalog_ids' : [ 1, 4 ],
      'prices' : [ 1.99, 2.99], 
      'provider_ids' : [ 3, 3],
      'providers' : [ "Rumblefish, Rumblefish" ]
    },
    {
      'version' : 1,
      'license_type' : 2,
      'rights' : ...,
      'purpose' : ...,
      'region' : ...,
      'term' : ...,
      'text' : ...,
      'catalog_ids' : [ 3, 4 ],
      'prices' : [ 1.99, 2.99], 
      'provider_ids' : [ 2, 3],
      'providers' : [ "CD Baby, Rumblefish" ]
    }
  ]
}

When you supply a license_key you will receive details of the track licensed and who licensed it, in a JSON tree.

{
  "transaction":  {
    "receipt"       : 5582667,
    "license_key"       : "1Q6PX37-WQD0PGL-HJZGJ7U-R3A4WOM-7XJ4",
    "project_reference"    : "my proj",
    "transaction_reference" : "AC34957304958VL",
    "media" : {
      "id"       :333,
      "provider_reference"  : "CMI472",
      "title"      : "CMI472 That Isn't Love",
      "genre"      : "Country",
      "duration"    : 189,
      "original_filename"  : "CMI.472.That Isn t Love.wav",
      "explicit"    : false,
      "artists" : [
        {
          "id"  : 101,
          "name"  : "Easterling & Gildersleeve"
        },
        {
          "id"  : 102,
          "name"  : "Stephen Easterling"
        },
        {
          "id"  : 103,
          "name"  : "Freddy Gildersleeve"
        }
      ],
      "catalog":
        {
          "id"     : 1,
          "name"   : "Crucial Music"
        }
      },
    "license" : {
      "id"      : 1,
      "license_type_version"  : 1,
      "license_type"    : 1,
      "purpose"    : "Internet & Website",
      "region"     : "Worldwide",
      "rights"    : "Non-commercial,non-broadcast",  
      "license_text"    : "/dev/null",
      "region"    : "Worldwide",  
      "term"      : "Unlimited"  
    },
    "licensee" : {
      "id":14,
      "created_at"    : "2011-11-22T12:21:36-08:00",
      "firstname"    : "J",
      "lastname"    : "Query",
      "company"    : "Rumblefish",
      "address1"     : "107 SE Washington",
      "address2"    : "Suite 700",
      "city"      : "Portland",
      "state"     : "OR",
      "postal_code"    : "97214",  
      "country"    : "USA",
      "phone"      : "j",
      "email"      : "tech@rumblefish.com",
      "licensee_reference" : "could_be_a_transaction_number_from_a_portal"
    }
  }
}
  

When you supply a receipt number, you will receive details for the entire transaction, including all of the individual licenses, and a pdf_url with a link to the PDF receipt.

Try It!

POST

Since the license is a legal document there are a large number of required parameters that help specify the identity of the licensee.

Parameter Options
media_id The media ID, or a group of media ID's. You may license more than one track per project.
token Your access token
license_type A selection from the license types provided by the GET method.
project_reference A project, typically a video, where the media will be published. NOTE: one license, one project.
transaction_reference A financial reference number to allow a portal financial transaction to tie back to a license transaction.
invoice_id Used instead of a transaction_reference if this is to be included under an invoice.
license_rate A license_rate can be provided directly, but it must meet or exceed the portal/catalog minimum rates returned by the license/token GET. When license_rate is not provided the portal/catalog minimum rate is used.
email The licensee's email address.
firstname The licensee's first name.
lastname The licensee's last name.
company The licensee's company.
address1 The licensee's first address line.
address2 The licensee's second address line.
city The licensee's city.
state The licensee's state.
postal_code The licensee's postal code or ZIP code.
country The licensee's country.
phone The licensee's phone number.
licensee_reference A licensee's internal portal reference number.
send_license Set this to 'false' to prevent api license emails.

Usage

Creates a license!

Try It!

DELETE

Parameter Options
token Your access token
license_key The license key from a track

Usage

This will cancel (invalidate) a given license_key (RADKey). Please note, it does not process any refunds or notify the customer. This should be called in conjuction with your portal issuing a refund to a customer.