Files
discogs-service/docs/data/documentation/discogsservice/client.json
T

1 line
44 KiB
JSON
Raw Normal View History

{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"anchor":"overview","type":"heading","level":2,"text":"Overview"},{"type":"paragraph","inlineContent":[{"text":"Some Discogs data is made available under the ","type":"text"},{"identifier":"https:\/\/creativecommons.org\/public-domain\/cc0\/","isActive":true,"type":"reference"},{"text":" license, and some is restricted data, as defined in our ","type":"text"},{"identifier":"https:\/\/support.discogs.com\/hc\/en-us\/articles\/360009334593-API-Terms-of-Use","isActive":true,"type":"reference"},{"text":".","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"Our monthly data dumps are available under the the ","type":"text"},{"identifier":"https:\/\/creativecommons.org\/public-domain\/cc0\/","overridingTitle":"CC0 No Rights Reserved","overridingTitleInlineContent":[{"text":"CC0 No Rights Reserved","type":"text"}],"isActive":true,"type":"reference"},{"text":" license.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"If you utilize the Discogs API, you are subject to the ","type":"text"},{"identifier":"https:\/\/support.discogs.com\/hc\/en-us\/articles\/360009334593-API-Terms-of-Use","overridingTitle":"API Terms of Use","overridingTitleInlineContent":[{"text":"API Terms of Use","type":"text"}],"isActive":true,"type":"reference"},{"text":". Please also ensure that any application you develop follows the Discogs ","type":"text"},{"identifier":"https:\/\/support.discogs.com\/hc\/en-us\/articles\/360009334593-API-Terms-of-Use","overridingTitle":"Application Name and Description Policy","overridingTitleInlineContent":[{"text":"Application Name and Description Policy","type":"text"}],"isActive":true,"type":"reference"}]},{"anchor":"Quickstart","type":"heading","level":1,"text":"Quickstart"},{"type":"paragraph","inlineContent":[{"text":"If you just want to see some results right now, issue this ","type":"text"},{"inlineContent":[{"text":"curl","type":"text"}],"type":"emphasis"},{"text":" command:","type":"text"}]},{"code":["curl https:\/\/api.discogs.com\/releases\/249504 --user-agent \"FooBarApp\/3.0\""],"syntax":"bash","type":"codeListing"},{"anchor":"General-information","type":"heading","level":1,"text":"General information"},{"type":"paragraph","inlineContent":[{"text":"General Information","type":"text"}]},{"type":"paragraph","inlineContent":[{"inlineContent":[{"text":"Your application must provide a User-Agent string that identifies itself","type":"text"}],"type":"strong"},{"text":" - preferably something that follows ","type":"text"},{"identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc1945#section-3.7","isActive":true,"type":"reference"},{"text":". Some good examples include:","type":"text"}]},{"code":["AwesomeDiscogsBrowser\/0.1 +http:\/\/adb.example.com","LibraryMetadataEnhancer\/0.3 +http:\/\/example.com\/lime","MyDiscogsClient\/1.0 +http:\/\/mydiscogsclient.org"],"syntax":null,"type":"codeListing"},{"type":"paragraph","inlineContent":[{"text":"Please dont just copy one of those! Make it unique so we can let you know if your application starts to misbehave - the alternative is that we just silently block it, which will confuse and infuriate your users.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"Here are some bad examples that are unclear or obscure the nature of the application:","type":"text"}]},{"code":["curl\/7.9.8 (i686-pc-linux-gnu) libcurl 7.9.8 (OpenSSL 0.9.6b)","Mozilla\/5.0 (X11; Linux i686; rv:6.0.2) Gecko\/20100101 Firefox\/6.0.2","my app"],"syntax":null,"type":"codeListing"},{"anchor":"Authentication","type":"heading","level":1,"text":"Authentication"},{"type":"paragraph","inlineContent":[{"text":"Most endpoints require authentication. The API supports multiple methods:","type":"text"}]},{"items":[{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Discogs Auth (Key & Secret):"}]},{"te