Skip to content

Utilisation de l'API

Johan le stickman edited this page Sep 9, 2023 · 5 revisions

Vous pouvez héberger une instance vous-même, ou utiliser celle déjà hébergée (URL : https://unshort-api.vercel.app / https://unshort-api.johanstick.fr).

GET /

Redirige vers ce repo GitHub

POST /

Lance une recherche sur un lien.

Accepte un body JSON contenant le lien via la propriété "link", ou une query qui contient la propriété "link" (exemple : https://unshort-api.johanstick.fr/?link=https://is.gd/t1kKVI).

Répond un objet JSON :

Si tout s'est bien passé

{
	"url": "L'url que vous avez donné",
	"redirected": "L'url original",
	"expiration": "date avant que le lien ne soit revérifié", // N'est retourné que si le lien a déjà été vérifié, et que l'enregistrement dans la base de données est activé
	"safe": true/false, // N'est pas renvoyé si la Navigation sécurisée Google n'est pas activée
	"metadata": [ // 3 éléments au maximum peuvent être renvoyés, si aucun n'est trouvé dans la page, l'array sera vide
		{
			"name": "title",
			"content": "Titre de la page"
		},
		{
			"name": "description",
			"content": "Description de la page, non tronqué"
		},
		{
			"name": "image",
			"content": "Lien vers une image, est peut être un chemin relatif"
		}
	]
}

En cas d'erreur

{
	"statusCode": xxx,
	"error": "Erreur, fait pour être court et universel",
	"message": "Contenu de l'erreur, assez user-friendly"
}

Liste des erreurs

  • statusCode: 400 | error: Invalid Link | message: Oups, le lien est invalide.
  • statusCode: 400 | error: No Link | message: Vous devez entrer la valeur "link" via les paramètres (query) ou un body JSON.
  • statusCode: 502 | error: Database Error Check | message: Une erreur est survenue avec la base de données lors de la vérification sur la BDD.
  • statusCode: 504 | error: Timeout | message: Le lien a mis trop de temps à répondre (<nombre de requêtes effectuées> requêtes).
  • statusCode: 302 | error: Unsupported Link | message: Ce lien n'est pas supporté par notre service.
  • statusCode: 502 | error: Database Error Insert | message: Une erreur est survenue avec la base de données lors de l'ajout du lien. Veuillez réessayer.
Clone this wiki locally