API Skyrock.com

Documentation développeur

Introduction

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 : http://www.skyrock.com/developer/documentation/.

API Skyrock

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

Authentification

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

/img/api/OAuthAPI-schema-768-fr.png

Présentation du processus d'autorisation OAuth

  1. L'application envoie une requête OAuth demandant un token temporaire en signant la demande à l'aide de sa clé secrète.
  2. Skyrock.com valide la demande et renvoi un token temporaire
  3. L'application fait une demande d'autorisation via le token temporaire
  4. Skyrock.com valide la demande et redirige l'utilisateur sur la page de demande d'acceptation de l'application
  5. L'utilisateur accepte la demande de l'application
  6. L'utilisateur est redirigé sur l'adresse de retour de l'application avec un nouveau token de vérification
  7. L'application fait une requête de demande de token définitif avec le token de vérification
  8. Skyrock.com valide la demande et renvoie à l'application un token définitif pour cet utilisateur

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/.

Comment utiliser l'API OAuth ?

  1. Créer un compte skyrock
  2. Enregistrer votre application
  3. Skyrock.com vous fournit une clé et un secret au format hmac-sha1
  4. Votre application peut utiliser l'API Skyrock en mode "Développement" via le protocole OAuth.
  5. Lorsque votre application est finalisée, vous pouvez faire une demande de validation, afin que votre application soit accessible à tout le monde.

Utilisation de Skyrock Connect

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.

Boutons Skyrock Connect

Les boutons suivants sont mis à disposition pour l'intégration de "Skyrock Connect" :

Log in with Skyrock Log in with Skyrock


Log in with Skyrock Log in with Skyrock


Log in with Skyrock Log in with Skyrock

A noter : le plugin Skyrock Connect Faces s'intègre facilement avec "Skyrock Connect".

Support API Skyrock.com

Nous vous conseillons d'utiliser une bibliothèque compatible OAuth 1.0a.

Bibliothèques OAuth

Ces bibliothèques OAuth ont été testées avec l'API Skyrock.com :

Les nombreuses bibliothèques tierces respectant le protocole OAuth 1.0a devraient fonctionner : http://oauth.net/code/

Bibliothèques tierces réalisées par la communauté

Services intégrant l'API Skyrock

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
  • Oneall Social Login plugins: easy social login, sign on & social network sharing
  • Gigya Social optimization

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 ?

Contactez-nous !