Aller au contenu

API - Shortlink

Description

Cette API permet pour la gestion de short link (créer, lire, modifier et supprimer des short links).

Un shortlink, un lien rapide vers des fonctionnalités ou des ressources Alemca, avec 3 niveaux d'authentification :

  • jwt : rendre le short link accessible avec une clé API ou une authentification Alemca.
  • password : rendre le short link accessible avec un mot de passe autogénéré à sa création.
  • none : rendre le short link accessible sans authentification.

Chaque shortlink a un nombre d'utilisation limité et une durée de vie limitée qui sont programmés à leur création :

  • limit_usage : définir le nombre de fois que le short link peut être utilisé.
  • remaining_usage : définir le nombre de fois qu'il reste à utiliser le short link.
  • ttl : définir le temps de vie du short link en secondes.

Il existe plusieurs types de short links, notamment le type :

  • remote : permettre au short link de créer une session remote directement, il faut donner les paramètres de connexion à sa création.

Attention

Lors de la création d’un shortlink dans le post, le champ json peut varier selon le type de shortlink. Vous pouvez trouver la liste des schémas possibles dans la description détaillée du schéma, en bas de la page, sous short_link_create/json. Il en va de même pour la réponse : elle varie également. La liste des formats possibles se trouve sous shortlink_use.

URL de Base

URL base pour API Shortlink : https://api.alemca.io/shortlink

✅ URL copiée !

Documentation API

Pour la documentation merci de voir le lien Swagger plus bas dans la page.

Tous les endpoints doivent être ajoutés après l'URL de base. Vous pouvez voir un exemple d'utilisation ci-dessous.

Example

https://api.alemca.io/shortlink/shortlink/manage/{ident}

Pour plus d’informations détaillées et la liste complète des endpoints, consultez la documentation Swagger de l'API Shortlink.