Mod Archive Forums Mod Archive Forums
Advanced search  

News:

Please note: Your main modarchive.org account will not work here, you must create a forum account to post on the forums.

Pages: [1] 2 3   Go Down

Author Topic: API key request  (Read 8059 times)

0 Members and 1 Guest are viewing this topic.

Vitamin

  • Devouring the Pies
  • Offline Offline
  • Posts: 15
    • View Profile
API key request
« on: October 24, 2015, 18:33:13 »

Hello!

I really don't want to parse html, so XML API is required:)

Application type: chiptunes player
Platform(s): crossplatform (API access required only for Android version)
Predicted demand: no idea, hope <100k requests per month (about 1500 active app users available, server-side search support is extremely required to reduce requests amount)
Commercial interest: nope, app is free and opensource

Required API features:
- list of authors (filter is highly desirable- loading and displaying almost 2k entries at once is not easy, paging is not applicable. BTW, there no filter for non-letter authors' names on the site). Count of available modules for each author is possible.
- list of modules for each author with filename and title info (size of track is also possible to be avail)
- list of modules for each genre with the same info as above
- top tracks by any relevant chart function (rating info is desirable, may be instead of file size)
- modules searching by case-insensitive substring in filename OR title (reference to author for each found track is highly required)

Homepage: http://zxtune.bitbucket.org/
GooglePlay: https://play.google.com/store/apps/details?id=app.zxtune
Logged

Saga Musix

  • TMA Moderator
  • Too much pie
  • *****
  • Offline Offline
  • Posts: 2215
  • I love OpenMPT! And Modules! And TMA! And Pie! :>
    • View Profile
    • Saga Musix - free module music and more!
Re: API key request
« Reply #1 on: October 25, 2015, 00:05:47 »

I've sent you a personal message. The things you want to do should all be doable with level 3 API access as far as I can see. Please keep in mind that many modules lack author information.
Logged
» My TMA artist profile
» Visit my music site: https://sagamusix.de/ [de, en]
» Visit my programming website: https://sagagames.de/ [de]
» Open ModPlug Tracker

Vitamin

  • Devouring the Pies
  • Offline Offline
  • Posts: 15
    • View Profile
Re: API key request
« Reply #2 on: October 25, 2015, 09:31:11 »

Quote
I've sent you a personal message. The things you want to do should all be doable with level 3 API access as far as I can see.
Thank you!

Quote
Please keep in mind that many modules lack author information.
Are that modues accessible from The Artist Directory? Usually, this problem is solved by adding special author called Unknown:)
Logged

Vitamin

  • Devouring the Pies
  • Offline Offline
  • Posts: 15
    • View Profile
Re: API key request
« Reply #3 on: October 25, 2015, 10:35:56 »

I've found some issues while playing with API:
1) search is performed only for non-authored modules (so it's really useless)
2) no way to find all the non-authored modules (to put them to artificial author's folder on the client side)
Logged

Vitamin

  • Devouring the Pies
  • Offline Offline
  • Posts: 15
    • View Profile
Re: API key request
« Reply #4 on: October 25, 2015, 11:03:53 »

Continue:)

3) view_by_list and view_by_rating requests doesn't work:

http://modarchive.org/data/xml-tools.php?key=<...>&request=view_by_list&query=a
returns
<error>Bad Request</error>

while

http://modarchive.org/data/xml-tools.php?key=<...>&request=view_by_rating&query=9
returns
<error>Invalid Request</error>

So, how can I get list of top tracks mentioned in requirements?
Logged

Saga Musix

  • TMA Moderator
  • Too much pie
  • *****
  • Offline Offline
  • Posts: 2215
  • I love OpenMPT! And Modules! And TMA! And Pie! :>
    • View Profile
    • Saga Musix - free module music and more!
Re: API key request
« Reply #5 on: October 25, 2015, 13:40:20 »

I'm not quite sure what you mean by 1). ModArchive itself is entirely based on the API, so in general the API allows you to do similar things as on the site. However, you can not search for a module and artist name at the same time as far as I'm aware.

3) were documentation errors, please see the updated documentation.
Logged
» My TMA artist profile
» Visit my music site: https://sagamusix.de/ [de, en]
» Visit my programming website: https://sagagames.de/ [de]
» Open ModPlug Tracker

Vitamin

  • Devouring the Pies
  • Offline Offline
  • Posts: 15
    • View Profile
Re: API key request
« Reply #6 on: October 25, 2015, 16:18:49 »

However, you can not search for a module and artist name at the same time as far as I'm aware.
I mean that search by title/filename is performed only for orphaned modules (which has no author info).

Briefly,

this: http://modarchive.org/index.php?request=search&query=glam&submit=Find&search_type=filename_or_songtitle

does not contain this: http://modarchive.org/index.php?request=view_by_moduleid&query=103413

Also, I haven't found any way to list orphaned modules at all.
Logged

Saga Musix

  • TMA Moderator
  • Too much pie
  • *****
  • Offline Offline
  • Posts: 2215
  • I love OpenMPT! And Modules! And TMA! And Pie! :>
    • View Profile
    • Saga Musix - free module music and more!
Re: API key request
« Reply #7 on: October 25, 2015, 18:22:44 »

It doesn't contain that specific song because you have to prepend an asterisk - otherwise the search will search for anything starting with "glam". Neither the filename nor the song title start with "glam", a search for "*glam" will find it though.
Logged
» My TMA artist profile
» Visit my music site: https://sagamusix.de/ [de, en]
» Visit my programming website: https://sagagames.de/ [de]
» Open ModPlug Tracker

Vitamin

  • Devouring the Pies
  • Offline Offline
  • Posts: 15
    • View Profile
Re: API key request
« Reply #8 on: October 25, 2015, 18:38:30 »

It doesn't contain that specific song because you have to prepend an asterisk - otherwise the search will search for anything starting with "glam". Neither the filename nor the song title start with "glam", a search for "*glam" will find it though.
Excellent! Definitely, this should be in docs!

And what about getting list of orphaned modules? What have I missed this time?:)
Logged

Saga Musix

  • TMA Moderator
  • Too much pie
  • *****
  • Offline Offline
  • Posts: 2215
  • I love OpenMPT! And Modules! And TMA! And Pie! :>
    • View Profile
    • Saga Musix - free module music and more!
Re: API key request
« Reply #9 on: October 25, 2015, 18:47:40 »

You cannot get an explicit list of modules that is not associated with any artist, as far as I'm aware.
Logged
» My TMA artist profile
» Visit my music site: https://sagamusix.de/ [de, en]
» Visit my programming website: https://sagagames.de/ [de]
» Open ModPlug Tracker
Pages: [1] 2 3   Go Up