Utiliser l'API Immich

Jochem
5 min read
Utiliser l'API Immich

Qu’est-ce qu’une API ? (Et pourquoi s’y intéresser ?)

Imaginez que vous êtes au restaurant. Vous regardez le menu, choisissez votre plat préféré et dites au serveur ce que vous voulez. Le serveur transmet votre commande à la cuisine et vous rapporte votre plat. Facile, non ?

Dans le monde de la tech, une API (Interface de Programmation d’Applications), c’est comme ce serveur. Elle permet à deux systèmes de communiquer et d’échanger des informations. Sans API, les applications ne sauraient pas comment récupérer vos vidéos de chats préférées, envoyer des messages ou même afficher la météo. (Et qui voudrait vivre sans vidéos de chats ?)


Pourquoi les APIs sont-elles géniales ?

Les APIs sont comme des ponts magiques qui relient différentes applications et systèmes. Elles font en sorte que tout fonctionne ensemble sans accroc. Voici ce qu’elles permettent :

  • Récupérer des infos : Comme obtenir la météo ou votre fil d’actualité.
  • Envoyer des infos : Comme téléverser une photo ou envoyer un message.
  • Automatiser des tâches : Comme synchroniser votre calendrier avec vos emails.
  • Ajouter des fonctionnalités sympas : Comme intégrer des cartes ou des paiements dans les applications.

Pensez aux APIs comme à des assistants invisibles qui rendent vos applications plus intelligentes et votre vie plus facile.


Découvrez l’API Immich : votre super-pouvoir photo

Maintenant que vous savez ce qu’est une API, parlons de l’API Immich. C’est comme un super-héros pour vos photos ! Voici ce qu’elle peut vous aider à faire :

  • Construire votre propre galerie photo personnalisée.
  • Automatiser les sauvegardes pour ne jamais perdre un souvenir.
  • Créer de nouvelles applications qui interagissent avec vos photos.

L’API Immich est là pour rendre la gestion de vos photos amusante, facile et puissante. Que vous soyez développeur ou simplement passionné de photos, elle a tout ce qu’il vous faut pour passer au niveau supérieur !


Découvrez le CLI Immich : votre assistant en ligne de commande

Le CLI Immich (Interface en Ligne de Commande) est comme une télécommande pour Immich que vous pouvez utiliser directement depuis le terminal de votre ordinateur. C’est super pratique si vous voulez téléverser rapidement des photos, organiser des albums ou automatiser des tâches sans ouvrir de navigateur.

De quoi avez-vous besoin pour l’utiliser ?

Avant de pouvoir utiliser le CLI Immich, assurez-vous d’avoir ces éléments prêts :

  1. Node.js et NPM :
    Le CLI fonctionne avec Node.js, vous devez donc l’installer d’abord. Pas d’inquiétude, c’est facile !

    • Rendez-vous sur nodejs.org et téléchargez la dernière version.
    • Lorsque vous installez Node.js, NPM (Node Package Manager) s’installe aussi automatiquement.
  2. Compte Immich :
    Vous aurez besoin d’un compte Immich pour vous connecter et utiliser le CLI.

  3. Accès au terminal :
    Vous utiliserez votre terminal (ou invite de commande) pour exécuter les commandes du CLI.

Comment installer le CLI Immich

Une fois Node.js et NPM installés, l’installation du CLI Immich est un jeu d’enfant. Ouvrez simplement votre terminal et tapez cette commande :

npm install -g immich-cli

Comment téléverser beaucoup de photos avec le CLI Immich

Le CLI Immich rend le téléversement d’un grand nombre de photos très simple. Voici comment faire, étape par étape :

Étape 1 : Obtenez votre clé API

Pour utiliser le CLI, vous aurez besoin d’une clé API Immich. Pensez-y comme à un mot de passe spécial qui permet au CLI d’accéder à votre compte Immich. Voici comment l’obtenir :

  1. Connectez-vous à votre compte Immich dans votre navigateur via https://.pixelunion.eu
  2. Allez dans Paramètres du compte et trouvez la section Clés API.
  3. Cliquez sur Nouvelle clé API et donnez-lui un nom (par exemple, “Téléversements CLI”).
  4. Copiez la clé API générée. Gardez-la en sécurité—vous en aurez besoin à l’étape suivante et elle donne accès à tout votre compte, comme un mot de passe !

Étape 2 : Connectez-vous au CLI

Une fois que vous avez votre clé API, vous pouvez vous connecter au CLI. Ouvrez votre terminal et tapez :

immich <url du serveur>/api <clé api>

Par exemple :

immich login https://mesphotos.pixelunion.eu/api iVAhMOtRARhqHpU6b2NINOPunu0obdEy0SVBtJI5gYmcQOU

Étape 3 : Utilisez le CLI Immich pour commencer le téléversement

Une fois connecté, vous pouvez commencer à téléverser vos photos sur Immich. Le CLI offre beaucoup de flexibilité, vous pouvez donc personnaliser la façon dont vous téléversez vos fichiers. Voici comment faire :

Commande de base pour téléverser

Pour téléverser un dossier de photos, utilisez la commande suivante :

immich-cli upload  /chemin/vers/vos/photos

Consultez l’aide de la commande CLI pour plus d’informations :

Usage: immich upload [paths...] [options]

Téléversez des fichiers

Arguments:
  paths                       Un ou plusieurs chemins vers les fichiers à téléverser

Options:
  -r, --recursive             Récursif (par défaut : false, env : IMMICH_RECURSIVE)
  -i, --ignore <pattern>      Motif à ignorer (env : IMMICH_IGNORE_PATHS)
  -h, --skip-hash             Ne pas calculer le hash avant le téléversement (par défaut : false, env : IMMICH_SKIP_HASH)
  -H, --include-hidden        Inclure les dossiers cachés (par défaut : false, env : IMMICH_INCLUDE_HIDDEN)
  -a, --album                 Créer automatiquement des albums selon le nom du dossier (par défaut : false, env : IMMICH_AUTO_CREATE_ALBUM)
  -A, --album-name <name>     Ajouter tous les fichiers à l'album spécifié (env : IMMICH_ALBUM_NAME)
  -n, --dry-run               Ne rien faire, juste afficher ce qui serait fait (par défaut : false, env : IMMICH_DRY_RUN)
  -c, --concurrency <number>  Nombre de fichiers à téléverser en même temps (par défaut : 4, env : IMMICH_UPLOAD_CONCURRENCY)
  --delete                    Supprimer les fichiers locaux après téléversement (env : IMMICH_DELETE_ASSETS)
  --no-progress               Masquer les barres de progression (env : IMMICH_PROGRESS_BAR)
  --watch                     Surveiller les changements et téléverser automatiquement (par défaut : false, env : IMMICH_WATCH_CHANGES)
  --help                      afficher l'aide pour la commande

Pour résumer

L’API et le CLI Immich sont des outils puissants qui rendent la gestion de vos photos plus facile, plus rapide et plus amusante. Que vous construisiez des applications personnalisées, automatisiez des sauvegardes ou téléversiez une immense bibliothèque de photos, Immich est là pour vous.

Si vous souhaitez aller plus loin avec le CLI Immich et découvrir toutes ses fonctionnalités, consultez la documentation officielle ici : Documentation CLI Immich.

Un immense merci à la communauté open source pour la création et la maintenance de ce superbe logiciel. Immich n’existerait pas sans le dévouement et le travail acharné des développeurs du monde entier. Si vous aimez Immich, pensez à contribuer ou à soutenir le projet !

Bonne gestion de vos photos !

(image de couverture par Douglas lopez)