Table des matières
L'API de Skyrock.com permet à une application d'interagir avec la plupart des fonctionnalités proposées par Skyrock.com : les blogs, les profils, la messagerie, le "quoi de neuf", les amis et l'activité.
L'API est accessible publiquement en lecture et nécessite une authentification OAuth 1.0a pour les méthodes à accès restreint. La liste des méthodes est disponible dans la documentation technique de l'API Skyrock.com.
L'adresse de référence de cette documentation est la suivante : https://www.skyrock.com/developer/documentation/.
L'API utilise le protocole http et reprend quelques principes des architectures REST. Les requêtes s'utilisent en GET pour la lecture et en POST pour l'écriture.
Les formats de retour sont en JSON ou XML.
Les paramètres passés en POST doivent être encodés en UTF-8.
L'accès aux méthodes de l'API se fait via une convention de nommage dans l'URL :
https://api.skyrock.(com|mobi)/v2/«NAMESPACE»/«METHODE».«FORMAT»/?arg1=paramètre1
Exemple :
Appel en JSON : https://api.skyrock.com/v2/user/get.json?username=lequipe-skyrock
Appel en XML : https://api.skyrock.com/v2/user/get.xml?username=lequipe-skyrock
La liste des méthodes est disponible dans la documentation technique de l'API Skyrock.com. Vous pouvez aussi explorer l'API depuis votre navigateur web via la console API.
Note
Accès mobile
Pour utiliser l'api depuis un client mobile, vous devez utiliser le domaine api.skyrock.mobi pour toutes les requêtes API.
Exemple :
Appel en JSON : https://api.skyrock.mobi/v2/user/get.json?username=lequipe-skyrock
Appel en XML : https://api.skyrock.mobi/v2/user/get.xml?username=lequipe-skyrock
Le protocole ouvert OAuth est utilisé pour authentifier l'application et fournir les autorisations d'accès à l'api.
OAuth est un protocole qui permet aux applications web, mobiles ou de bureaux, d'accéder aux services distants via l'API, sans demander aux utilisateurs d'exposer leur identité (identifiant / mot de passe).
Skyrock.com supporte aujourd'hui la version 1.0a du protocole OAuth.
Présentation du processus d'autorisation OAuth
9 et 10. L'application peut effectuer des requêtes authentifiées via OAuth
Note
Pour plus d'informations sur OAuth, nous vous conseillons de vous reporter à la documentation officielle : http://oauth.net/.
Un client OAuth existe dans la majorité des langages de programmation. Une liste des diverses implémentations est disponible sur le site de OAuth : http://oauth.net/code/.
Note
URLs OAuth
Le service "Skyrock Connect" permet de disposer d'une authentification simplifiée en proposant une connexion en un clic pour les utilisateurs Skyrock. Le protocole OAuth est utilisé via la méthode oauth/authenticate. Cette méthode est utilisée à la place de oauth/authorize dans le processus d'autorisation OAuth. Ainsi, pour utiliser le service "Skyrock Connect", l'application doit envoyer les tokens temporaires en paramètres à la méthode oauth/authenticate.
Voici les différents cas d'utilisation de la méthode oauth/authenticate :
- Si l'utilisateur est déjà connecté sur skyrock.com et qu'il a déjà accepté l'application, l'utilisateur sera immédiatement authentifié et redirigé vers l'URL de callback.
- Si l'utilisateur n'est pas connecté sur skyrock.com et qu'il a déjà accepté l'application, la page de connexion Skyrock sera proposée à l'utilisateur. Après connexion, il sera immédiatement authentifié et redirigé vers l'URL de callback.
- Si l'utilisateur est déjà connecté sur skyrock.com et qu'il n'a pas accepté l'application, la page de demande d'acceptation de l'application sera proposée à l'utilisateur. Après acceptation, il sera immédiatement authentifié et redirigé vers l'URL de callback.
- Si l'utilisateur n'est pas connecté sur skyrock.com et qu'il n'a pas accepté l'application, la page de connexion Skyrock sera proposée à l'utilisateur. Après connexion, la page de demande d'acceptation de l'application sera proposée. Après acceptation, il sera immédiatement authentifié et redirigé vers l'URL de callback.
Les boutons suivants sont mis à disposition pour l'intégration de "Skyrock Connect" :
A noter : le plugin Skyrock Connect Faces s'intègre facilement avec "Skyrock Connect".
Nous vous conseillons d'utiliser une bibliothèque compatible OAuth 1.0a.
Ces bibliothèques OAuth ont été testées avec l'API Skyrock.com :
- [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
Les nombreuses bibliothèques tierces respectant le protocole OAuth 1.0a devraient fonctionner : http://oauth.net/code/
- [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
Ces services permettent d'utiliser les fonctionnalités de l'API (Skyrock Connect, partage...) de manière très simple.
- apigee: Learn and explore Skyrock.com API
- Skyrock apigee console: https://www.skyrock.com/developer/api-console/
- Skyrock API resources: https://apigee.com/resources/skyrock
- Oneall Social Login plugins: easy social login, sign on & social network sharing
- Gigya Social optimization
- Gigya setup howto: http://developers.gigya.com/010_Developer_Guide/82_Socialize_Setup/005_Opening_External_Applications/Skyrock
- Wordpress plugin: http://wordpress.org/extend/plugins/gigya-socialize-for-wordpress/
- Drupal module: http://drupal.org/project/gigya
Note
Besoin d'aide ?
Vous souhaitez intégrer le réseau Skyrock.com sur votre site web ou votre application ? Vous souhaitez donner de la visibilité à votre application ? Vous avez besoin d'une aide technique ?