La version API d'URLmini est maintenant disponible (25/07/2009 - Version 1.0) get.php (API 1.0) get.php - retourne une urlmini (exemples) Description
string get ( [ int $format=TEXT , string $perso ,] string $url )
get() retourne une urlmini en fonction de url et des paramètres facultatifs format et perso. Si une erreur survient durant l'exécution de la fonction, cette dernière ne retournera pas d'urlmini mais une chaine de caractère expliquant l'erreur rencontrée.
Liste des paramètres
format
Cette fonction a comme premier argument facultatif, format, qui indique le format de retour de la fonction. Vous pouvez utiliser l'une des constantes suivantes la valeur par défaut étant TEXT :
Constantes disponibles pour format
perso
Cette fonction a comme deuxième argument facultatif, perso, qui permet de personnaliser l'urlmini créée. Toutes les caractères alpha-numériques, qui respèctent la règle REGEX suivante, sont acceptés : [a-zA-Z0-9_-], avec un maximum de 20 caractères (les caractères HTML sont interdits). Toute autre caractère non autorisé entrainera automatiquement une erreur qui sera retournée à la place de l'url minimisée.
url
Le seul paramètre obligatoire de cette fonction est l'url d'origine que l'on souhaite minimiser.
Valeur de retour
Retourne la chaîne minisée en fonction du format choisie (TEXT par défaut) ou, si une erreur est servenue, retournera une chaîne de caractère qui expliquera le problème rencontré.
Avertissement L'ordre des paramètres de la fonction est très important. Il faut absolument placer les paramètres facultatifs, format et/ou perso AVANT le paramètre obligatoire url afin de pouvoir minimiser les url avec des paramètres, comme les recherches de google par exemple. Si les paramètres facultatifs sont placés APRES le paramètre obligatoire, ils seront considérés comme appartenant à l'url à minimiser et ne seront donc pas pris en compte. Merci de regarder les exemples pour de plus amples détails.Limite d'utilisation Afin d'éviter les abus, il n'est pas possible de faire appel aux fonctions de l'API plus de 10 fois par minutes. Au delà de 10 appels par minutes, l'API retournera uniquement des messages d'erreurs. Merci d'en tenir compte si vous souhaitez utiliser l'API d'URLmini.net dans de gros projets. En fonction de la demande, je pourrais éventuellement revoir cette limite à la hausse.
Historique
Exemples
Exemple #1 sans paramètres facultatifs
<?php $urlmaxi = "http://www.google.fr/search?hl=fr&safe=off&num=50&newwindow=1&q=urlmini+Free+short+url&meta="; $urlmini = file_get_contents("http://urlmini.net/api-get.php?url=".$urlmaxi); if ( preg_match ('#^(http)#',$urlmini ) ) { //Si le retour de la fonction est une chaine de caractère commençant par http://xxxx //C'est OK, l'urlmini a été créée et est active. On peut donc l'afficher echo "<a href=\"".$urlmini."\" title=\"Lien raccourci automatiquement par l'API d'URLmini.net\">".$urlmini."</a>"; } else { //Sinon, on ré-affiche l'url d'origine et on affiche dans la balise title l'erreur renvoyée par la fonction echo "<a href=\"".$urlmaxi."\" title=\"".$urlmini."\">".$urlmaxi."</a>"; } ?> Un exemple d'utilisation plus complet est disponible sur l'excellent site de Jay Salvat http://blog.jaysalvat.com/articles/remplacer-de-longues-url-par-des-tinyurl-a-la-volee.php. L'exemple a été réalisé avec l'API de tinyurl mais il fonctionne également avec l'API d'URLmini (il suffit juste de remplacer le lien http://tinyurl.com/api-create.php par http://urlmini.net/api-get.php).
Exemple #2 nature du retour en fonction du format choisi
Test de la fonction avec le format TEXT
http://urlmini.net/api-get.php?format=TEXT&url=http://www.google.fr/search?hl=fr&q=urlmini+Free+short+url&meta= La chaine retournée sera la suivantehttp://urlmini.net/YAMDVW8 En cas d'erreur, la chaine retournée sera la suivanteUne chaine de caractères qui vous indiquera l'erreur rencontrée Le code compris dans l'exemple #1 gère le format TEXTTest de la fonction avec le format XML http://urlmini.net/api-get.php?format=XML&url=http://www.google.fr/search?hl=fr&q=urlmini+Free+short+url&meta= La chaine retournée sera la suivante<?xml version="1.0" encoding="UTF-8"?> En cas d'erreur, la chaine retournée sera la suivante<response> <job>OK <urlmini>http://urlmini.net/YAMDVW8</urlmini> </response> <?xml version="1.0" encoding="UTF-8"?> N'étant pas spécialiste de l'XML, je ne peux pour le moment pas vous proposer un code complet (comme dans l'exemple #1) d'utilisation de l'API avec ce format de sortie. Si quelqu'un se propose de faire un p'tit bout de code pour gérer le XML, qu'il prenne contact avec le responsable du site sinon, Google est votre ami.<response> <job>ERROR <urlmini>Une chaine de caractères qui vous indiquera l'erreur rencontrée</urlmini> </response> Copyright © 2008-2009 - URLmini.net - Règlement - API - Contact
Reproduction interdite sans autorisation Ce site est hébergé par OVH Page générée en 0.027 secondes |