Développeurs d'App

Introduction

API

En tant que développeur, vous pouvez créer des applications et de les ajouter à Maison de la Floride, profitant de la base d'utilisateurs existants. Vous hébergez l'application, ce qui signifie que vous avez le contrôle complet sur vos spécifications de serveur.

Configuration d'une APP

Pour interagir avec Maison de la Floride votre application peut envoyer des appels à notre API et demander ou poster des informations.

Lorsque vous ajoutez une application à notre site nous vous donnerons un Numéro d'APP.

Demande de code

Chaque fois que vous prévoyez d'utiliser notre API, vous devez d'abord demander un code. Afin de demander un code, vous avez besoin d'une clé unique que nous vous envoyons quand un utilisateur visite votre application à partir d'une iframe sur notre site. Nous transmettons ceci de cette façon $_GET['key'].

Ceci est un exemple de la méthode pour demander un code:

http://maisondelafloride.com/token.php?key=$_GET['key']

En cas de succès, vous obtiendrez une réponse JSON comme:


Object
(
    [token] => LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUc4d0RRWUpLb1pJaHZjTkFRRUJCUUFEWGdBd1d3SlVBdHFZdmVWOXFEdDd6NFhXTXYzS3VZM2JyWXpUKzR0VgpBbERrN1dQWjhqRVpoVzBNWjE1Z3lHdGNlNm5ueFRNenp4SXpHM29BRVIzc0JVRCtYdStHb21JeVV4UE1RN1NtCkVPdFg0ZTNwekp6R081cUxBZ01CQUFFPQotLS0tLUVORCBQVUJMSUMgS0VZLS0tLS0K
)

Envoi d'une demande

Maintenant que vous avez un code d'accès, vous pouvez faire des demandes à notre serveur. A chaque demande, vous devez passer le code d’accès que nous avons créé pour vous.

Par exemple, un appel à notre serveur API ressemblerait à:

http://maisondelafloride.com/api.php?token=#{TOKEN}&method=#{METHOD_NAME}

Comprendre une réponse API

Pour les méthodes qui pourraient retourner plus d'un élément, la réponse contiendra un indicateur du total disponible ainsi que le nombre de pages. Nous retournons par défaut 10 items au maximum et afin d'obtenir les 10 prochains items, vous devez saisir le paramètre "page=2".

Sur la gauche, vous trouverez une liste des modules qui mettent en œuvre des méthodes API. Cliquez sur le module et vous verrez une liste des méthodes que votre application peut utiliser. À des fins de brièveté et de formatage dont nous n'incluons pas la demande complète, mais uniquement les parties les plus pertinentes.

friend

getFriends

GET /api.php?method=friend.getFriends&user_id=#{USER_ID}

Fourni la liste d'amis complète pour un utilisateur spécifique. Si vous ne trouvez pas le nombre #{USER_ID} nous renverrons les informations à l'utilisateur qui est actuellement connecté

Réponse


Object
(
    [api] => Object
        (
            [total] => 1
            [pages] => 0
            [current_page] => 0
        )

    [output] => Array
        (
            [0] => Object
                (
                    [user_id] => 7
                    [user_name] => jane-doe
                    [full_name] => Jane Doe
                    [joined] => 1314110027
                    [country_iso] => US
                    [gender] => Female
                    [photo_50px] => http://maisondelafloride.com/file/pic/user/7_50.jpg
                    [photo_50px_square] => http://maisondelafloride.com/file/pic/user/7_50_square.jpg
                    [photo_120px] => http://maisondelafloride.com/file/pic/user/7_120.jpg
                    [photo_original] => http://maisondelafloride.com/file/pic/user/7.jpg
                    [profile_url] => http://maisondelafloride.com/index.php?do=/jane-doe/
                )

        )

)

isFriend

GET /api.php?method=friend.isFriend&user_id=#{USER_ID}&friend_user_id=#{FRIEND_USER_ID}

Contrôle si 2 utilisateurs sont amis ou non. Si vous ne passez pas le numéro #{USER_ID} nous renverrons les informations à l'utilisateur qui est actuellement connecté.

Réponse


Object
(
    [api] => Object
        (
            [total] => 0
            [pages] => 0
            [current_page] => 0
        )

    [output] => Object
        (
            [is_friend] => 1
        )

)

mail

getNewCount

GET /api.php?method=mail.getNewCount&user_id=#{USER_ID}

Obtenir le nombre de messages non-vus. Si vous ne saisissez pas l'identifiant #{USER_ID} nous retournerons cette information à l'usager qui est en ligne.

Réponse


Object
(
    [api] => Object
        (
            [total] => 0
            [pages] => 0
            [current_page] => 0
        )

    [output] => 1
)

notification

getNewCount

GET /api.php?method=notification.getNewCount&user_id=#{USER_ID}

Pour obtenir le nombre des notifications non vues. Si vous ne saisissez pas l'identifiant utilisateur #{USER_ID} Nous retournerons cette information à l'usager qui est branché.

Réponse


Object
(
    [api] => Object
        (
            [total] => 5
            [pages] => 0
            [current_page] => 0
        )

    [output] => 5
)

get

GET /api.php?method=notification.get&user_id=#{USER_ID}

Recevoir toutes les notifications des usagers. Si vous ne saisissez pas l'identifiant utilisateur #{USER_ID} Nous retournerons cette information à l'usager qui est branché.

Réponse


Object
(
    [api] => Object
        (
            [total] => 0
            [pages] => 0
            [current_page] => 0
        )

    [output] => Array
        (
            [0] => Object
                (
                    [notification_id] => 3
                    [link] => http://maisondelafloride.com/john-doe/comment-id_1/
                    [message] => Jane Doe commented on your wall
                    [icon] => http://maisondelafloride.com/module/blog/static/image/default/default/activity.png
                )

        )

)

photo

addPhoto

POST /api.php?method=photo.addPhoto&photo=#{@FILE_PATH;TYPE=MIME_TYPE}&photo_name=#{BASE_FILE_NAME}

Uploads a photo on behalf of the user.

Réponse


Object
(
    [api] => Object
        (
            [total] => 0
            [pages] => 0
            [current_page] => 0
        )

    [output] => Object
        (
            [original] => http://maisondelafloride.com/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d.jpg
            [75px] => http://maisondelafloride.com/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d_75.jpg
            [100px] => http://maisondelafloride.com/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d_100.jpg
            [150px] => http://maisondelafloride.com/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d_150.jpg
            [240px] => http://maisondelafloride.com/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d_240.jpg
            [500px] => http://maisondelafloride.com/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d_500.jpg
            [1024px] => http://maisondelafloride.com/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d_1024.jpg
        )

)

getPhotos

GET /api.php?method=photo.getPhotos&user_id=#{USER_ID}

Obtenir toutes les photos d'un utilisateur. Si vous ne saisissez pas l'identifiant utilisateur #{USER_ID} nous retournerons l'information à l’usager en ligne.

Réponse


Object
(
    [api] => Object
        (
            [total] => 1
            [pages] => 0
            [current_page] => 0
        )

    [output] => Array
        (
            [0] => Object
                (
                    [photo_100px] => http://maisondelafloride.com/file/pic/photo/c81e728d9d4c2f636f067f89cc14862c_100.jpg
                    [photo_240px] => http://maisondelafloride.com/file/pic/photo/c81e728d9d4c2f636f067f89cc14862c_240.jpg
                    [photo_original] => http://maisondelafloride.com/file/pic/photo/c81e728d9d4c2f636f067f89cc14862c.jpg
                )

        )

)

user

getUser

GET /api.php?method=user.getUser&user_id=#{USER_ID}

Obtenir des informations sur un usager basé sur son ID que vous avez saisi. Si vous n'avez pas saisi l'identifiant {USER_ID} nous retournerons l'information vers l'usager qui est en ligne.

Réponse


Object
(
    [api] => Object
        (
            [total] => 0
            [pages] => 0
            [current_page] => 0
        )

    [output] => Object
        (
            [user_id] => 1
            [user_name] => john-doe
            [joined] => 1314109907
            [gender] => Male
            [country_iso] => US
            [full_name] => John Doe
            [email] => john.doe@site.com
            [photo_50px] => http://maisondelafloride.com/file/pic/user/2011/08/9d673759d1cf55c9cd0b0805dc32e68e_50.jpg
            [photo_50px_square] => http://maisondelafloride.com/file/pic/user/2011/08/9d673759d1cf55c9cd0b0805dc32e68e_50_square.jpg
            [photo_120px] => http://maisondelafloride.com/file/pic/user/2011/08/9d673759d1cf55c9cd0b0805dc32e68e_120.jpg
            [photo_original] => http://maisondelafloride.com/file/pic/user/2011/08/9d673759d1cf55c9cd0b0805dc32e68e.jpg
            [profile_url] => http://maisondelafloride.com/index.php?do=/john-doe/
        )

)