L'API en lecture seule d'AstroBin

En bref

AstroBin met en œuvre un ensemble de base d'API RESTful. Actuellement, les API sont en lecture seule et vous permettent d'obtenir des données sur les images et d'effectuer quelques recherches de base.

À l'aide de l'API d'AstroBin, vous pourrez créer votre propre site Web, application de bureau ou application mobile qui pourra utiliser certains contenus d'AstroBin.

Quelques possibilités :

  • Un widget web qui affiche les images récentes d'un certain utilisateur.

  • Un widget web qui affiche l'image du jour.

  • Un iPhone/Androïde pour naviguer efficacement dans AstroBin.

  • ... et bien d'autres encore !

Disponibilité et limites

Les API d'AstroBin sont actuellement limitées à la récupération d'informations de base et à l'exécution de recherches simples sur les images.

Les types de réponse pris en charge sont XML et JSON.

Comment commencer

La première chose dont vous aurez besoin est une clé API. Veuillez utiliser le formulaire de demande de clé API pour en obtenir une.

Comment afficher les images

La réponse de l'API vous fournira plusieurs propriétés url_*, chacune représentant une taille d'image différente.

Usage loyal

Il est interdit d'utiliser les API pour gratter impitoyablement tout le contenu disponible. Le non-respect de cette exigence entraînera la révocation permanente de la clé API.

Veuillez lire la section sur les API dans les conditions de service.

Quelques exemples

Veuillez noter que tous les exemples omettent l'URL de base, les paramètres d'authentification et le paramètre de format. Vous devez vous souvenir de les inclure dans une utilisation réelle, par exemple :

http://astrobin.com/api/v1/.../?...&api_key=...&api_secret=...&format=json

N'oubliez pas que vous pouvez combiner la plupart de ces requêtes, alors n'hésitez pas à expérimenter !

Obtenir une seule image par ID :

image/1234/

Recherche par sujet :

image/?subjects=M31

# Note : la recherche par sujets est limitée à 100 résultats pour des raisons de performance.

Recherche par utilisateur :

image/?user=siovene

Recherche par titre partiel, insensible à la casse :

image/?title__icontains=andromeda

Recherche insensible à la casse, description partielle :

image/?description__icontains=wind

Autres astuces partielles utiles :

__startswith=
__endswith=
__contenu=
__istartswith=
__iendswith=

Recherche par plage de dates de téléchargement :

image/?uploaded__gte=2012-04-10%200:00:00&uploaded__lt=2012-04-11%200:00:00

Opérateurs de comparaison :

__lt=
__lte=
__gt=
__gte=

Obtenez l'image du jour :

imageoftheday/?limit=1

Obtenez l'image du jour d'hier :

imageoftheday/?limit=1&offset=1

Obtenez les meilleurs choix :

toppick/

Obtenez les nominations pour le meilleur choix :

toppicknomination/

Obtenir un utilisateur par son ID :

profil de l'utilisateur/1234

Obtenir un utilisateur par son nom d'utilisateur :

profil utilisateur/?nom d'utilisateur=siovene

Bibliothèques communautaires

Applications et widgets communautaires