Error: Failed to load processor TracNav
No macro or processor named 'TracNav' found

Error: Failed to load processor TOC
No macro or processor named 'TOC' found

Ce document est aussi disponible en Anglais.

BlogMarks?.net : Formats XML

Ce document décrit la syntaxe XML des données pour l'API Atom de blogmarks.net.

L'API Atom n'étant pas finalisée, les informations fournies dans ce document ne sont qu'à titre indicative. L'API de blogmarks.net peut changer d'içi la version 1.0.

Version

Ceci est la version 0.1 de ce document.

Introduction

La spécification de l'API Atom de blogmarks.net indique comment communiquer avec le serveur. Ce document explique les différents formats XML manipulés pour décrire les ressources de blogmarks.

La majeure partie des éléments XML décrits ci-dessous sont des éléments définis par la dernière spécification du format Atom. On a du étendre ce format quelque fois pour enrichir les descriptions des blogmarks et des tags, les deux ressources principales manipulées dans blogmarks. Cette extension a été faite en utilisant les espaces de nom XML.

Syntaxe d'un blogmark

Un blogmark est l'élément de base de notre projet. C'est une sorte de bookmark (favoris, ou marque page) auquel on a ajouté un ensemble de méta données. Tous les utilisateurs pourront ajouter des blogmarks sur le serveur. Ils pourront être publics ou privés. A ces blogmarks, l'utilisateur peut ajouter des mos-clés, appelés tags, afin de les classer pour permettre à d'autres ou à lui même de les retrouver plus facilement.

Id

C'est l'identifiant "atom" du blogmark. Il est unique et auto généré par le serveur lorsque le mark est créé. Il sera de la forme : 'tag:blogmarks.net,2005:marks,432'. Aucune information ne doit être déduite de ce tag et il doit être conservé dans sa totalité.

PostURI FeedURI EditURI
Interdit Présent GET : Présent, PUT : Optionnel

link[@rel=related]

Pointe sur l'URI "blogmarké".

PostURI FeedURI EditURI
Obligatoire Présent GET : Présent, PUT : Obligatoire

link[@rel=alternate]

Pointe sur la représentation html du blogmark.

PostURI FeedURI EditURI
Interdit Présent GET : présent, PUT : Interdit

link[@rel=image]

Pointe sur la capture d'écran du site "blogmarké".

PostURI FeedURI EditURI
Interdit Présent GET : présent, PUT : Interdit

edit

Pointe sur l'EditURI du blogmark.

PostURI FeedURI EditURI
Interdit Présent GET : présent, PUT : Interdit

title

Titre du blogmark.

PostURI FeedURI EditURI
Obligatoire Présent GET : Présent, PUT : Obligatoire

summary

Description du blogmark.

PostURI FeedURI EditURI
Optionnel Optionnel GET : Optionnel, PUT : Optionnel

published

Date de publication du blogmark.

PostURI FeedURI EditURI
Peut être indiqué si la date de publication ne correspond pas à la date où le mark est créé. La date de publication est le seul moyen de spécifier qu'un mark est privé. Le client devra alors envoyer une date nulle dans la balise issued. On peut aussi envoyer une date future à laquelle le mark sera public. Est présent s'il n'est pas nul. GET : Est présent s'il n'est pas nul., PUT : Cf. PostURI

bm:created

Date de création du blogmark.

PostURI FeedURI EditURI
Interdit Présent GET : Présent, PUT : Interdit

updated

Date de dernière modification du blogmark.

PostURI FeedURI EditURI
Interdit Présent GET : Présent, PUT : Interdit

author

Auteur du blogmark.

PostURI FeedURI EditURI
Peut être présent mais ne sera pas utilisé par le serveur. Le nom du propriétaire du mark sera le login de l'utilisateur. Présent GET : Présent, PUT : Optionnel

category

Tag associé au blogmark : 

<category term="http://api.blogmarks.net/tags" sheme="/atom" label="atom"/>
<category term="http://api.blogmarks.net/user/benoit/tags" sheme="/MesProjets" label="MesProjets"/>
PostURI FeedURI EditURI
Optionnel Optionnel GET : Optionnel, PUT : Optionnel

Syntaxe d'un tag

Id

C'est l'identifiant "atom" du tag. Il est unique et auto généré par le serveur lorsque le mark est créé. Il sera de la forme : 'tag:blogmarks.net,2005:tags,145'. Aucune information ne doit être déduite de ce tag et il doit être conservé dans sa totalité.

PostURI FeedURI EditURI
Interdit Présent GET : Présent, PUT : Obligatoire

link[@rel=alternate]

Pointe sur la représentation html du tag.

PostURI FeedURI EditURI
Interdit Présent GET : Présent, PUT : Interdit

link[@rel=image]

Pointe sur une image associé au tag.

PostURI FeedURI EditURI
Optionnel Optionnel GET : Optionnel, PUT : Optionnel

edit

Pointe sur l'EditURI du blogmark.

PostURI FeedURI EditURI
Interdit Présent GET : Présent, PUT : Interdit

title

Titre du tag.

PostURI FeedURI EditURI
Obligatoire Présent GET : Présent, PUT : Obligatoire

summary

Description du tag.

PostURI FeedURI EditURI
Optionnel Optionnel GET : Optionnel, PUT : Optionnel

published

Date de publication du tag.

PostURI FeedURI EditURI
L'utilisateur ne pouvant créer que des tags privés, la date de publication n'a pas de sens içi

Optionnel (Toujours présent pour les tags publics) GET : Peut être présent (Est présent pour les tags publics), PUT : Cf. PostURI

bm:created

Date de création du tag.

PostURI FeedURI EditURI
Interdit Présent GET : Présent, PUT : Interdit

updated

Date de dernière modification du tag.

PostURI FeedURI EditURI
Interdit Présent GET : Présent, PUT : Interdit

Syntaxe d'un feed

Un feed contient un en-tête (head) et une liste d'entrées. L'en-tête peut contenir les éléments suivants.

title

Titre du feed généré par le serveur en fonction de la requête.

alternate

Lien vers le feed correspondant de l'interface blogmarks.net.

link[@rel=prev]

Lien vers le feed précédent s'il existe. Permet de naviguer entre les réponses d'une requête.

link[@rel=next]

Lien vers le feed suivant s'il existe.

updated

La plus grande date de dernière modification des entrées du feed résultat.

Syntaxe des messages d'erreur

Lorsque le serveur rencontre une erreur, il renvoit dans le corps de la réponse un message précisant cette erreur, du type : 

<?xml version="1.0"?>
<message xmlns="http://api.blogmarks.net/ns#">No user connected</message>

Voir aussi : Fr/DeveloperDocs, Fr/AtomApiSpec