Skip to content

Latest commit

 

History

History
157 lines (135 loc) · 7.02 KB

using-7digital-api.md

File metadata and controls

157 lines (135 loc) · 7.02 KB
description
This guide describes how to use the 7digital API endpoints to access the UMG catalog made available for this hackathon

UMG Catalog / 7digital API

Overview

Universal Music Group have made a some of their songs available for this hackathon

  • ≈ 20,000 songs
  • ≈ 1,500 unique artists
  • ≈ 5,000 albums/singles
  • Covers many genres, rock, pop, country....etc
  • Spans each decade from 1960's to present

7digital have activated some of their API endpoints to get access to the UMG catalog

  • Browse catalog and discover artists, albums and tracks
  • Get data for artists, albums and tracks - artist name, album title, track name
  • Retrieve album artwork (CD covers) for every album in the catalog
  • Stream full length audio files for every song in the catalog

API Architecture

Catalog Schema

​List of catalog metadata can be found on this page​

Accessing UMG Catalog using 7digital API

Access to UMG catalog using 7digital services (API)

  • Provided through a REST style interface
  • Controlled by a consumer key that needs to passed in as a parameter
  • consumer_key = 7d4vr6cgb392
  • Identified by a shop identifier that needs to be passed in as a parameter
  • shopId = 2020

Streaming audio files requires API requests to be signed with an oauth 1.0 signature

  • Sign requests using consumer key and secret
  • consumer_key = 7d4vr6cgb392
  • consumer_secret = m4ntskavq56rddsa

Sample API Call

​http://api.7digital.com/1.2/artist/search?shopId=2020&oauth_consumer_key=7d4vr6cgb392&q=john​

Call Components Meaning
http://api.7digital.com/1.2 7digital API site and version
artist/search API endpoint name - search artists
?shopId=2020 Parameter to identify UMG catalog
&oauth_consumer_key=7d4vr6cgb392 Parameter for consumer key
&q=john Parameter for search query string

API Endpoint List

The following table lists the endpoints that we have made available for this hackathon. For each endpoint there is a sample call that works and returns real results. Click on these links to see how each call is constructed and obtain the call responses

Endpoint Use Sample Call Main Parameter
Artist browse Browse the catalog for artist names that start with supplied text string ​GET artist/browse​ letter={text}
Artist search Search the catalog for artists that match a supplied text string ​GET artist/search​ q={text}
Artist releases Returns a list of streamable releases for a specific artist ​GET artist/releases​

&artistId={int}

&usageTypes=adsupportedstreaming
Artist toptracks Returns a list of streamable tracks for a specific artist ​GET artist/toptracks​

&artistId={int}

&usageTypes=adsupportedstreaming
Release search

Search the catalog for releases

that match a supplied text string

 ​GET release/search​

&q={text}

&usageTypes=adsupportedstreaming
Release tracks Returns a list of streamable tracks for a specific release ​GET release/tracks​

&releaseId={int}

&usageTypes=adsupportedstreaming
Track search Search the catalog for releases that match a supplied text string ​GET track/search​

&q={text}

&usageTypes=adsupportedstreaming
Track stream Stream full length (or partial clip) audio for a specific track See later page &trackId={int}