Drupal Services module: Getting the API key or kid of the requester

The services_keyauth_get_kid() function.

I'm currently in the process of building a module to work with Analytics SEO. This module connects to Analytics SEO via the Services module. There has been some debate as to how to manage permissions. The 'correct' way is to log the user in and then use the usual Drupal access permissions system which would be great but I really don't like the way you submit the password in plain text.

My suggestion is to bind a user to the API key id (kid) although for a lot of people having a user per API key isn't needed or would be overkill - The services module works really well with anonymous calls, or key restricted function calls. But when different people are using the same functions with sensitive data there has to be a proper way of securing the data. The answer as I've suggested is to tie it all up with the API key or kid as it's stored in the database.

I spent several hours, trundling through Google and the module code itself before finally stumbling upon services_keyauth_get_kid(). Finally! I don't know why this was so hard to find, probably because it's quite easy to write your own function to query the database against the domain, but again I didn't want to do that because I was sure there would be some function that would do all of the security stuff for you:

services_keyauth_get_kid()

For those of you that are interested, I'm aiming to make this THE SEO module for Drupal. Yes there are other modules out there but they either don't do much, don't give ongoing analysis or are a pain to install. I'm pretty excited to be building this module because it will incorporate the best of both worlds: The awesome power of Analytics SEO with all its crawling, site audit to check all your pages, keyword and competitor analysis together with the advantages of being hooked right into your site e.g. to automatically analyse your page when you save it, suggest content changes and compare it against competitors, all in a well organised manner to make it quick to optimise your site.

Submitted by oliver on Mon, 04/04/2011 - 17:50

• oliver's blog
• 45493 reads