API Skyrock.com Documentation - Skyrock Developers

Introduction

Skyrock.com API allows an application to interact with most features proposed by Skyrock.com: blogs, profiles, messaging, "what's new", friends and activities.

The API is publicly available for reading and requires an OAuth 1.0a authentication for methods with restricted access. The list of methods is available in the technical documentation of Skyrock.com API.

The address of this documentation is as follows : https://www.skyrock.com/developer/documentation/.

Skyrock API

The API uses the HTTP protocol and incorporates some principles of REST architectures. Queries are used with GET for reading and with POST for writing.

Responses are available in JSON or XML.

POST parameters must be encoded in UTF-8.

Access to the API methods is made via a naming convention in the URL:

https://api.skyrock.(com|mobi)/v2/«NAMESPACE»/«METHODE».«FORMAT»/?arg1=paramètre1

Example :

Call in JSON : https://api.skyrock.com/v2/user/get.json?username=lequipe-skyrock

Call in XML : https://api.skyrock.com/v2/user/get.xml?username=lequipe-skyrock

The list of methods is available in the technical documentation of Skyrock.com API. You can explore this API using our API console.

Note

Mobile access

To use the API from a mobile terminal, you must use the domain api.skyrock.mobi for all the API queries.

Example :

Call in JSON : https://api.skyrock.mobi/v2/user/get.json?username=lequipe-skyrock

Call in XML : https://api.skyrock.mobi/v2/user/get.xml?username=lequipe-skyrock

Authentication

The open protocol OAuth is used to authenticate the application and provide the access permissions to the API.

OAuth is a protocol that enables web, mobile and desktop applications to access remote services via the API. And without requiring users to state their identity (username / password).

Skyrock.com now supports version 1.0a of the OAuth protocol.

Overview of the OAuth authorization flow

Overview of the authorization process OAuth

The application sends an OAuth query requesting for a temporary token while signing the request using its secret key
Skyrock.com validates the request and return a temporary token
The application makes a request for authorization via temporary token
Skyrock.com validates the request and redirects the user to the page of request for acceptance of the application
The user accepts the request from the application
The user is redirected to the return address of the application with a new token for verification
The application requests for a final token with the verification token
Skyrock.com validates the request and sends back a final token to the application for the user

9 / 10. The application can then make requests authenticated via OAuth

Note

For more information on OAuth, you should refer to official documentation : http://oauth.net/.

An OAuth client exist in most programming languages. A list of various implementations are available on OAuth site : http://oauth.net/code/.

How to use the OAuth API?

Create an account on Skyrock
Register your application
Skyrock.com provides you with a key and a secret format hmac-sha1
Your application can use the Skyrock API in "Development" mode via OAuth protocol.
When your application is finalized, you can apply for validation, so that your application will be accessible to everyone.

Note

OAuth URLs

Request token URL : https://api.skyrock.com/v2/oauth/initiate
Authorize URL : https://api.skyrock.com/v2/oauth/authorize
Access token URL : https://api.skyrock.com/v2/oauth/token
Authenticate URL (see Using Skyrock Connect) : https://api.skyrock.com/v2/oauth/authenticate

Using Skyrock Connect

The service "Skyrock Connect" can have an authentication feature by offering a one-click connection to users Skyrock. The OAuth protocol is used via oauth/authenticate method. This method is used in place of oauth / authorize the OAuth authorization process. To use "Skyrock Connect" service, the application must send the temporary tokens as parameters to the method oauth / authenticate.

Here are the various case for oauth / authenticate method :

If the user is already logged on skyrock.com and has already accepted the application, the user is immediately authenticated and redirected to the callback URL.

If the user is not logged on skyrock.com and has already accepted the application, the login page Skyrock will be proposed to the user. After connecting, he will be immediately authenticated and redirected to the callback URL.

If the user is already logged on skyrock.com and has not accepted the application, the application page of acceptance of the application will be proposed to the user. Upon acceptance, he will be immediately authenticated and redirected to the callback URL.

If the user is not logged on skyrock.com and has not accepted the application, the Skyrock login page will be proposed to the user. After connecting, the page request acceptance of the application will be proposed. Upon acceptance, the user will be immediately authenticated and redirected to the callback URL.

Skyrock Connect Buttons

The following buttons are available for the integration of "Skyrock Connect":

Skyrock.com API Support

A list of OAuth libraries. Feel free to contact us to report a working library.

OAuth libraries

These libraries are known to work with Skyrock.com OAuth API.

[PHP] PECL OAuth: http://pecl.php.net/package/oauth

[PHP] Zend Framework / Zend OAuth: http://framework.zend.com/

[PHP] Symfony / sfOauthPlugin: http://www.symfony-project.org/

[PHP] OAuth-php: http://code.google.com/p/oauth/

[PHP] OAuthSimple: https://github.com/jrconlin/oauthsimple

[JavaScript] jsOAuth: https://github.com/bytespider/jsOAuth

[Python] Python-OAuth: http://code.google.com/p/oauth/

[Python] Python-OAuth2: https://github.com/simplegeo/python-oauth2

Other untested OAuth 1.0a libraries should work : http://oauth.net/code/

Skyrock.com API third party libraries

These Skyrock.com libraries are contributed by members of the community:

[PHP] HybridAuth, open source social sign on php library (Plugins and Addons available for Wordpress, Drupal, Elgg, CodeIgniter, CakePHP): http://hybridauth.sourceforge.net/

[PHP - Symfony] sfMelodyPlugin: Easy connection between other service supports OAuth: https://github.com/chok/sfMelodyPlugin

[PHP - Zend Framework] Sauth: A Social authentication library for Zend Framework. https://github.com/nnixaa/sauth

[PHP - Wordpress] WordPress Social Login, Skyrock connect on Wordpress http://wordpress.org/extend/plugins/wordpress-social-login/

[PHP - Guzzle] Guzzle is a PHP HTTP client & framework for building RESTful web service clients. http://guzzlephp.org/

[PHP] Skyrock OAuth API Library by Cédric Boverie: http://code.google.com/p/skyrock-api-class/

[nodejs] Everyauth integration by Rodolphe Stoclin: https://github.com/bnoguchi/everyauth

[nodejs] connect-auth: Authentication middleware for connect. https://github.com/ciaranj/connect-auth

[Python] Django Social Auth is an easy to setup social authentication/authorization mechanism for Django projects: https://github.com/omab/django-social-auth

[Java/Android] scribe: OAuth made so easy your grandma can do it! https://github.com/fernandezpablo85/scribe-java

[ios/Obj-C] DDSocialNetworkClient is a handy library that makes access to social networking on iPhone/iPad: https://github.com/ddeville/DDSocialClient

Skyrock.com API

Developer documentation

Introduction

Skyrock API