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]   Go Down

Author Topic: API Key request  (Read 5722 times)

0 Members and 1 Guest are viewing this topic.

Peppi

  • Devouring the Pies
  • Offline Offline
  • Posts: 13
    • View Profile
API Key request
« on: May 25, 2016, 23:10:20 »

  • Application type: ProTrackR
  • Platform(s): R (available on multiple platforms)
  • Predicted demand, an estimation of how many requests a month you will make: Hard to tell, best guess is about 200 per month
  • Commercial interest, is this a for-sale app?: No, it is available for free under a GPL-3 license

A level 3 Key would suffice. A note: it's probably hard to keep the Key secret for this package, as it is published as open source. The package is currently scraping information from html. I think it's preferable for all parties to use an API Key. Is it possible for key owners to keep track of the traffic?

Hope to hear from you...

Cheers,

Pepijn
Logged

Saga Musix

  • TMA Moderator
  • Too much pie
  • *****
  • Offline Offline
  • Posts: 2632
  • 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: May 25, 2016, 23:16:08 »

There are several other open-source projects using an API key, and it's pretty simple to keep it secret: Don't commit it together with the rest of the files. Every user must get their own key. For a pre-compiled binaries (if that is possible), you may include your own key of course.
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

Peppi

  • Devouring the Pies
  • Offline Offline
  • Posts: 13
    • View Profile
Re: API Key request
« Reply #2 on: May 26, 2016, 22:46:37 »

Thank you for the quick reply!

Unfortunately, I can only provide the CRAN repository with source files. Binary files are created on their server. So the best way forward is to keep my key (that is if I get one) out of the source code and ask users to request their own key here. I really have no clue on how many people actually use the package and how many will request a key. Can you live with that?

Cheers...
Logged

Saga Musix

  • TMA Moderator
  • Too much pie
  • *****
  • Offline Offline
  • Posts: 2632
  • I love OpenMPT! And Modules! And TMA! And Pie! :>
    • View Profile
    • Saga Musix - free module music and more!
Re: API Key request
« Reply #3 on: May 28, 2016, 14:48:28 »

As far as I understand the thing you write is a library. Maybe it would be an option to add a "register" method to your source package so that people call this function with their own key whenever they want to make use of this functionality?
Anyway, I'm going to send you a key in a private message, but as said, this is not meant to be spread.
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

Peppi

  • Devouring the Pies
  • Offline Offline
  • Posts: 13
    • View Profile
Re: API Key request
« Reply #4 on: May 28, 2016, 16:52:27 »

Thank you! You are correct that it is some form of library. I will keep this key to myself and will provide users with instructions to get their own key in the manual. I can change the functions such that they need to be called with the provided key.
Logged
Pages: [1]   Go Up