Fonctions disponibles (mise à jour le 26 mai 2011)
create.php - créer et retourner une URLmini en fonction de paramètres
verify.php - retourne l'URL d'origine d'une URLmini (prochainement)
detail.php - retourne des informations d'une URLmini (prochainement)

L'API d'URLmini.net

Application Programming Interface (API) C'est ici que seront affichées les dernières infos du site. Choisissez la date de la news que vous souhaiter voir dans la partie de droite. Il n'y aura pas d'annonces des nouveautés sur la page d'accueil d'URLmini.net donc, n'hésitez pas à venir de temps en temps ici. Pour plus d'informations sur le fonctionnement, merci de vous rendre dans la Foire Aux Questions (FAQ)

La version API d'URLmini est maintenant disponible (12/08/2011 - Version 1.1)

create.php (API 1.0 - 1.1)

create.php - créer et retourner une urlmini (exemples)

Description
string create ( [ const $format=TEXT , string $perso , const $private=Y ] string $url )
create() 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
ConstanteDescription
TEXTRetourne l'urlmini créée sous forme d'une chaine de caractère simple (format par défaut)
XMLRetourne l'urlmini créée sous forme d'une structure xml

Toute autre constante qui ne se trouve pas dans le tableau ci-dessus génèrera une erreur qui sera détaillée dans la variable de retour de la fonction
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). Tout autre caractère non autorisé entrainera automatiquement une erreur qui sera retournée à la place de l'url minimisée.
private
Cette fonction a comme troisième argument facultatif, private, qui permet d'indiquer si le lien créé sera public ou privé (voir la FAQ pour plus d'explication). Vous pouvez utiliser l'une des constantes suivantes la valeur par défaut étant Y :

Constantes disponibles pour private
ConstanteDescription
YIndique que l'on souhaite un lien privé (valeur par défaut)
NIndique que l'on souhaite un lien publice

Toute autre constante qui ne se trouve pas dans le tableau ci-dessus génèrera une erreur qui sera détaillée dans la variable de retour de la fonction.
url
Le seul paramètre obligatoire de cette fonction est l'url d'origine que l'on souhaite minimiser, brûte et non encodée.

 

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 30 fois par minutes. Au delà de 30 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
VersionDescription
1.1Ajout du paramètre facultatif private.
1.0Mise en ligne de la version public.
0.4bTest en ligne, correction des bugs de fonctionnement.
0.3bAjout du paramètre facultatif format.
0.2bAjout du paramètre facultatif perso.
0.1bMise en place d'une version bêta à usage restreint.

 

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";
$urlmini = file_get_contents(https://urlmini.net/"api-create.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 https://urlmini.net/api-create.php).

 

Exemple #2 nature du retour en fonction du format choisi
Test de la fonction avec le format TEXT
https://urlmini.net/api-create.php?format=TEXT&url=http://www.google.fr/search?hl=fr&q=urlmini+Free+short+url
La chaine retournée sera la suivante
https://urlmini.net/r/XXXXXXX
En cas d'erreur, la chaine retournée sera la suivante
Une chaine de caractères qui vous indiquera l'erreur rencontrée
Le code compris dans l'exemple #1 gère le format TEXT
Test de la fonction avec le format XML
https://urlmini.net/api-create.php?format=XML&url=http://www.google.fr/search?hl=fr&q=urlmini+Free+short+url
La chaine retournée sera la suivante
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <job>OK</job>
  <urlmaxi>http://www.google.fr/search?hl=fr&q=urlmini+Free+short+url</urlmaxi>
  <urlmini>https://urlmini.net/r/XXXXXXX</urlmini>
  <private>YES</private>
</response>
En cas d'erreur, la chaine retournée sera la suivante
Une chaine de caractères qui vous indiquera l'erreur rencontrée
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.
 

 

Exemple #3 nature du retour en fonction du format choisi et des paramètres personnalisés
Test de la fonction avec le format TEXT et une urlmini que l'on veut personnaliser
https://urlmini.net/api-create.php?format=TEXT&perso=test&url=http://www.google.fr/search?hl=fr&q=urlmini+Free+short+url
La chaine retournée sera la suivante
https://urlmini.net/r/test
En cas d'erreur, la chaine retournée sera la suivante
Une chaine de caractères qui vous indiquera l'erreur rencontrée
Le code compris dans l'exemple #1 gère le format TEXT
Test de la fonction avec le format XML et une urlmini que l'on veut personnaliser
https://urlmini.net/api-create.php?format=XML&perso=test&private=N&url=http://www.google.fr/search?hl=fr&q=urlmini+Free+short+url
La chaine retournée sera la suivante
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <job>OK</job>
  <urlmaxi>http://www.google.fr/search?hl=fr&q=urlmini+Free+short+url</urlmaxi>
  <urlmini>https://urlmini.net/r/test</urlmini>
  <private>NO</private>
</response>
En cas d'erreur, la chaine retournée sera la suivante
Une chaine de caractères qui vous indiquera l'erreur rencontrée
Dans cette exemple, on voit bien que l'on a réduit une url avec une personnalisation, test dans notre exemple, et que l'urlmini sera publique. Pour bien comprendre la notion entre lien privé et lien public, je vous engage à lire la Foire Aux Questions (FAQ)