Usar la API de Immich

¿Qué es una API? (¿Y por qué es importante?)
Imagina que estás en un restaurante. Miras el menú, eliges tu plato favorito y le dices al camarero lo que quieres. El camarero lleva tu pedido a la cocina y te trae la comida. Fácil, ¿verdad?
En tecnología, una API (Interfaz de Programación de Aplicaciones) es como ese camarero. Ayuda a que dos sistemas se comuniquen e intercambien información. Sin APIs, las apps no sabrían cómo mostrar tus vídeos de gatos favoritos, enviar mensajes o mostrar el clima. (¿Y quién quiere vivir sin vídeos de gatos?)
¿Por qué las APIs son geniales?
Las APIs son como puentes mágicos que conectan diferentes apps y sistemas. Hacen que todo funcione sin problemas. ¿Qué pueden hacer?
- Obtener datos: Por ejemplo, datos del clima o feeds de redes sociales.
- Enviar datos: Subir fotos o enviar mensajes.
- Automatizar: Sincronizar calendarios con emails.
- Agregar funciones: Mapas, pagos y más.
Las APIs son los ayudantes invisibles que hacen tus apps más inteligentes y tu vida más fácil.
La API de Immich: tu superhéroe de fotos
Ahora que sabes qué es una API, te presentamos la API de Immich. ¡Es como un superhéroe para tus fotos! Con ella puedes:
- Crear tu propia galería de fotos.
- Automatizar copias de seguridad para no perder recuerdos.
- Desarrollar nuevas apps que trabajen con tus fotos.
La API de Immich hace que la gestión de fotos sea fácil, flexible y potente, tanto para desarrolladores como para aficionados.
La CLI de Immich: tu ayudante en la terminal
La CLI de Immich (Interfaz de Línea de Comandos) es como un control remoto para Immich que puedes usar directamente en la terminal. Perfecta para subir fotos rápidamente, organizar álbumes o automatizar tareas.
¿Qué necesitas?
Node.js y NPM:
La CLI funciona con Node.js, así que primero debes instalarlo.- Ve a nodejs.org y descarga la última versión.
- Al instalar Node.js, NPM (Node Package Manager) se instala automáticamente.
Cuenta de Immich:
Necesitas una cuenta de Immich para iniciar sesión y usar la CLI.Acceso a la terminal:
Usarás tu terminal (o consola de comandos) para ejecutar los comandos de la CLI.
¿Cómo instalar la CLI de Immich?
Una vez que tengas Node.js y NPM instalados, instalar la CLI de Immich es muy fácil. Abre tu terminal y escribe:
npm install -g immich-cli
Cómo subir muchas fotos con la CLI de Immich
Con la CLI de Immich puedes subir muchas fotos de una sola vez. Así es como se hace paso a paso:
Paso 1: Consigue tu clave API
Para usar la CLI necesitas una clave API de Immich. Es como una contraseña especial que permite a la CLI acceder a tu cuenta de Immich. Así la consigues:
- Inicia sesión en tu cuenta de Immich en tu navegador en https://
.pixelunion.eu - Ve a Configuración de la cuenta y busca la sección Claves API.
- Haz clic en Nueva clave API y ponle un nombre (por ejemplo, “Subidas CLI”).
- Copia la clave API generada. Guárdala bien—la necesitarás en el siguiente paso y da acceso a toda tu cuenta, como una contraseña.
Paso 2: Inicia sesión en la CLI
Cuando tengas tu clave API, puedes iniciar sesión en la CLI. Abre tu terminal y escribe:
immich <url del servidor>/api <clave api>
Por ejemplo:
immich login https://misfotos.pixelunion.eu/api iVAhMOtRARhqHpU6b2NINOPunu0obdEy0SVBtJI5gYmcQOU
Paso 3: Usa la CLI de Immich para subir fotos
Una vez conectado, puedes empezar a subir tus fotos a Immich. La CLI es flexible y puedes personalizar cómo subes tus archivos. Así funciona:
Comando básico para subir
Para subir una carpeta de fotos, usa el siguiente comando:
immich-cli upload /ruta/a/tus/fotos
Consulta la ayuda del comando CLI para más información:
Usage: immich upload [paths...] [options]
Sube archivos
Argumentos:
paths Una o más rutas a los archivos a subir
Opciones:
-r, --recursive Recursivo (por defecto: false, env: IMMICH_RECURSIVE)
-i, --ignore <pattern> Patrón a ignorar (env: IMMICH_IGNORE_PATHS)
-h, --skip-hash No calcular hash antes de subir (por defecto: false, env: IMMICH_SKIP_HASH)
-H, --include-hidden Incluir carpetas ocultas (por defecto: false, env: IMMICH_INCLUDE_HIDDEN)
-a, --album Crear álbumes automáticamente según el nombre de la carpeta (por defecto: false, env: IMMICH_AUTO_CREATE_ALBUM)
-A, --album-name <name> Añadir todos los archivos al álbum especificado (env: IMMICH_ALBUM_NAME)
-n, --dry-run No hacer nada, solo mostrar lo que se haría (por defecto: false, env: IMMICH_DRY_RUN)
-c, --concurrency <number> Número de archivos a subir al mismo tiempo (por defecto: 4, env: IMMICH_UPLOAD_CONCURRENCY)
--delete Borrar archivos locales después de subir (env: IMMICH_DELETE_ASSETS)
--no-progress Ocultar barras de progreso (env: IMMICH_PROGRESS_BAR)
--watch Vigilar cambios y subir automáticamente (por defecto: false, env: IMMICH_WATCH_CHANGES)
--help mostrar ayuda para el comando
Resumen
La API y la CLI de Immich son herramientas potentes que hacen que la gestión de tus fotos sea más fácil, rápida y flexible. Ya sea que crees apps propias, automatices copias de seguridad o subas grandes colecciones, Immich lo hace posible.
Si quieres saber más sobre la CLI de Immich y todas sus funciones, consulta la documentación oficial: Documentación CLI Immich.
Un gran agradecimiento a la comunidad open source por este gran proyecto. Si te gusta Immich, ¡apoya el proyecto!
¡Disfruta gestionando tus fotos!
(Imagen de portada de Douglas lopez)