Usando a API do Immich

Jochem
5 min read
Usando a API do Immich

O que é uma API? (E por que você deveria se importar?)

Imagine que você está em um restaurante. Você olha o cardápio, escolhe seu prato favorito e diz ao garçom o que quer. O garçom leva seu pedido para a cozinha e traz sua comida de volta. Fácil, não?

No mundo da tecnologia, uma API (Interface de Programação de Aplicações) é como esse garçom. Ela ajuda dois sistemas a conversarem e trocarem informações. Sem APIs, os aplicativos não saberiam como buscar seus vídeos de gatos favoritos, enviar mensagens ou mostrar a previsão do tempo. (E quem quer viver sem vídeos de gatos?)


Por que as APIs são tão legais?

APIs são como pontes mágicas que conectam diferentes aplicativos e sistemas. Elas fazem tudo funcionar junto de forma suave. Veja o que elas podem fazer:

  • Buscar informações: Como pegar atualizações do tempo ou seu feed de redes sociais.
  • Enviar informações: Como fazer upload de uma foto ou enviar uma mensagem.
  • Automatizar tarefas: Como sincronizar seu calendário com seu e-mail.
  • Adicionar recursos legais: Como mapas ou opções de pagamento em apps.

Pense nas APIs como ajudantes invisíveis que tornam seus aplicativos mais inteligentes e sua vida mais fácil.


Conheça a API do Immich: Seu superpoder para fotos

Agora que você sabe o que são APIs, vamos falar sobre a API do Immich. É como um super-herói para suas fotos! Veja o que ela pode fazer por você:

  • Criar sua própria galeria de fotos personalizada.
  • Automatizar backups para nunca perder uma memória.
  • Criar novos aplicativos que funcionam com suas fotos.

A API do Immich está aqui para tornar o gerenciamento de fotos divertido, fácil e poderoso. Seja você desenvolvedor ou apenas alguém que ama fotos, ela tem tudo para levar suas fotos ao próximo nível!


Conheça o Immich CLI: Seu ajudante no terminal

O Immich CLI (Interface de Linha de Comando) é como um controle remoto para o Immich que você pode usar direto do terminal do seu computador. É super útil se você quiser enviar fotos rapidamente, organizar álbuns ou automatizar tarefas sem abrir o navegador.

O que você precisa para usar?

Antes de usar o Immich CLI, certifique-se de ter o seguinte:

  1. Node.js e NPM:
    O CLI funciona com Node.js, então instale primeiro.

    • Acesse nodejs.org e baixe a versão mais recente.
    • Ao instalar o Node.js, o NPM (Node Package Manager) é instalado automaticamente.
  2. Conta Immich:
    Você precisa de uma conta Immich para fazer login e usar o CLI.

  3. Acesso ao terminal:
    Você usará o terminal (ou prompt de comando) para executar os comandos do CLI.

Como instalar o Immich CLI?

Depois de instalar o Node.js e o NPM, instalar o Immich CLI é fácil. Abra o terminal e digite:

npm install -g immich-cli

Como enviar várias fotos com o Immich CLI

Com o Immich CLI você pode enviar várias fotos de uma vez. Veja como fazer passo a passo:

Passo 1: Obtenha sua chave de API

Para usar o CLI, você precisa de uma chave de API do Immich. É como uma senha especial que permite ao CLI acessar sua conta Immich. Veja como conseguir:

  1. Faça login na sua conta Immich pelo navegador em https://.pixelunion.eu
  2. Vá em Configurações da conta e procure a seção Chaves de API.
  3. Clique em Nova chave de API e dê um nome (por exemplo, “Uploads CLI”).
  4. Copie a chave gerada. Guarde bem — você vai precisar no próximo passo e ela dá acesso total à sua conta, como uma senha.

Passo 2: Faça login no CLI

Com a chave de API em mãos, faça login no CLI. Abra o terminal e digite:

immich <url do servidor>/api <chave api>

Por exemplo:

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

Passo 3: Use o Immich CLI para enviar fotos

Depois de logado, você pode começar a enviar suas fotos para o Immich. O CLI é flexível e permite personalizar como você faz upload dos arquivos. Veja como:

Comando básico para upload

Para enviar uma pasta de fotos, use o comando:

immich-cli upload /caminho/para/suas/fotos

Consulte a ajuda do CLI para mais informações:

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

Envia arquivos

Argumentos:
  paths                       Um ou mais caminhos para os arquivos a enviar

Opções:
  -r, --recursive             Recursivo (padrão: false, env: IMMICH_RECURSIVE)
  -i, --ignore <pattern>      Padrão para ignorar (env: IMMICH_IGNORE_PATHS)
  -h, --skip-hash             Não calcular hash antes do upload (padrão: false, env: IMMICH_SKIP_HASH)
  -H, --include-hidden        Incluir pastas ocultas (padrão: false, env: IMMICH_INCLUDE_HIDDEN)
  -a, --album                 Criar álbuns automaticamente pelo nome da pasta (padrão: false, env: IMMICH_AUTO_CREATE_ALBUM)
  -A, --album-name <name>     Adicionar todos os arquivos ao álbum especificado (env: IMMICH_ALBUM_NAME)
  -n, --dry-run               Não faz nada, só mostra o que seria feito (padrão: false, env: IMMICH_DRY_RUN)
  -c, --concurrency <number>  Número de arquivos enviados ao mesmo tempo (padrão: 4, env: IMMICH_UPLOAD_CONCURRENCY)
  --delete                    Apagar arquivos locais após upload (env: IMMICH_DELETE_ASSETS)
  --no-progress               Ocultar barras de progresso (env: IMMICH_PROGRESS_BAR)
  --watch                     Monitorar mudanças e enviar automaticamente (padrão: false, env: IMMICH_WATCH_CHANGES)
  --help                      mostrar ajuda para o comando

Resumo

A API e o CLI do Immich são ferramentas poderosas que tornam o gerenciamento de fotos mais fácil, rápido e flexível. Seja para criar apps próprios, automatizar backups ou enviar grandes coleções, o Immich faz tudo isso possível.

Para saber mais sobre o Immich CLI e todos os seus recursos, consulte a documentação oficial: Documentação CLI Immich.

Um grande agradecimento à comunidade open source por este projeto incrível. Se você gosta do Immich, apoie o projeto!

Aproveite para gerenciar suas fotos!

(Imagem de capa de Douglas lopez)