De Immich API gebruiken

Jochem
5 min read
De Immich API gebruiken

Wat is een API? (En waarom zou het je iets kunnen schelen?)

Stel je voor: je zit in een restaurant. Je bekijkt het menu, kiest je favoriete gerecht en vertelt de ober wat je wilt. De ober brengt je bestelling naar de keuken en komt terug met je eten. Simpel, toch?

In de tech-wereld is een API (Application Programming Interface) net als die ober. Het zorgt ervoor dat twee systemen met elkaar kunnen praten en informatie kunnen uitwisselen. Zonder API’s zouden apps niet weten hoe ze je favoriete kattenvideo’s moeten ophalen, berichten moeten sturen of zelfs het weer moeten tonen. (En wie wil er nu leven zonder kattenvideo’s?)


Waarom zijn API’s zo handig?

API’s zijn als magische bruggen die verschillende apps en systemen met elkaar verbinden. Ze zorgen ervoor dat alles soepel samenwerkt. Dit kunnen ze bijvoorbeeld doen:

  • Dingen ophalen: Zoals het weerbericht of je social media feed.
  • Dingen versturen: Zoals een foto uploaden of een bericht sturen.
  • Automatisch dingen doen: Zoals je agenda synchroniseren met je e-mail.
  • Coole functies toevoegen: Zoals kaarten of betaalopties in apps.

Zie API’s als de onzichtbare helpers die je apps slimmer maken en je leven makkelijker.


Maak kennis met de Immich API: Jouw foto-superkracht

Nu je weet wat API’s zijn, laten we het hebben over de Immich API. Dit is als een superheld voor je foto’s! Dit kun je ermee doen:

  • Je eigen fotogalerij bouwen.
  • Back-ups automatiseren zodat je nooit een herinnering verliest.
  • Nieuwe apps maken die met je foto’s werken.

De Immich API maakt het beheren van je foto’s leuk, makkelijk en krachtig. Of je nu een ontwikkelaar bent of gewoon van foto’s houdt, je hebt alles in huis om je foto’s naar een hoger niveau te tillen!


Maak kennis met de Immich CLI: Jouw command-line helper

De Immich CLI (Command-Line Interface) is als een afstandsbediening voor Immich die je direct vanuit je terminal kunt gebruiken. Superhandig als je snel foto’s wilt uploaden, albums wilt organiseren of taken wilt automatiseren zonder een browser te openen.

Wat heb je nodig om het te gebruiken?

Voordat je de Immich CLI kunt gebruiken, zorg dat je het volgende hebt:

  1. Node.js en NPM:
    De CLI draait op Node.js, dus die moet je eerst installeren. Geen zorgen, dat is eenvoudig!

    • Ga naar nodejs.org en download de nieuwste versie.
    • Als je Node.js installeert, wordt NPM (Node Package Manager) automatisch mee geïnstalleerd.
  2. Immich-account:
    Je hebt een Immich-account nodig om in te loggen en de CLI te gebruiken.

  3. Toegang tot de terminal:
    Je gebruikt je terminal (of command prompt) om de CLI-commando’s uit te voeren.

Hoe installeer je de Immich CLI

Als je Node.js en NPM hebt geïnstalleerd, is de Immich CLI installeren een fluitje van een cent. Open je terminal en typ:

npm install -g immich-cli

Hoe upload je veel foto’s met de Immich CLI

Met de Immich CLI kun je heel eenvoudig in één keer veel foto’s uploaden. Zo doe je dat stap voor stap:

Stap 1: Haal je API-sleutel op

Om de CLI te gebruiken heb je een API-sleutel van Immich nodig. Zie het als een speciaal wachtwoord waarmee de CLI met jouw Immich-account kan praten. Zo haal je hem op:

  1. Log in op je Immich-account in je browser via https://.pixelunion.eu
  2. Ga naar Accountinstellingen en zoek het gedeelte API Keys.
  3. Klik op Nieuwe API Key en geef hem een naam (bijvoorbeeld “CLI Uploads”).
  4. Kopieer de gegenereerde API-sleutel. Bewaar hem goed—je hebt hem zo weer nodig en hij geeft toegang tot je hele account, net als een wachtwoord!

Stap 2: Inloggen met de CLI

Als je je API-sleutel hebt, kun je inloggen met de CLI. Open je terminal en typ:

immich <server url>/api <api key>

Bijvoorbeeld:

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

Stap 3: Gebruik de Immich CLI om te uploaden

Zodra je bent ingelogd kun je beginnen met het uploaden van je foto’s naar Immich. De CLI biedt veel flexibiliteit, zodat je zelf kunt bepalen hoe je je bestanden uploadt. Zo werkt het:

Basis upload-commando

Om een map met foto’s te uploaden, gebruik je het volgende commando:

immich-cli upload  /pad/naar/jouw/fotos

See the help for the CLI command for more information:

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

Upload assets

Arguments:
  paths                       One or more paths to assets to be uploaded

Options:
  -r, --recursive             Recursive (default: false, env: IMMICH_RECURSIVE)
  -i, --ignore <pattern>      Pattern to ignore (env: IMMICH_IGNORE_PATHS)
  -h, --skip-hash             Don't hash files before upload (default: false, env: IMMICH_SKIP_HASH)
  -H, --include-hidden        Include hidden folders (default: false, env: IMMICH_INCLUDE_HIDDEN)
  -a, --album                 Automatically create albums based on folder name (default: false, env: IMMICH_AUTO_CREATE_ALBUM)
  -A, --album-name <name>     Add all assets to specified album (env: IMMICH_ALBUM_NAME)
  -n, --dry-run               Don't perform any actions, just show what will be done (default: false, env: IMMICH_DRY_RUN)
  -c, --concurrency <number>  Number of assets to upload at the same time (default: 4, env: IMMICH_UPLOAD_CONCURRENCY)
  --delete                    Delete local assets after upload (env: IMMICH_DELETE_ASSETS)
  --no-progress               Hide progress bars (env: IMMICH_PROGRESS_BAR)
  --watch                     Watch for changes and upload automatically (default: false, env: IMMICH_WATCH_CHANGES)
  --help                      display help for command

Afronding

De Immich API en CLI zijn krachtige tools die het beheren van je foto’s makkelijker, sneller en leuker maken. Of je nu eigen apps bouwt, back-ups automatiseert of een enorme fotobibliotheek uploadt: Immich helpt je erbij.

Wil je dieper duiken in de Immich CLI en alle mogelijkheden ontdekken? Bekijk dan de officiële documentatie: Immich CLI Documentatie.

Een groot dankjewel aan de open-source community voor het maken en onderhouden van deze geweldige software. Immich zou niet mogelijk zijn zonder de inzet en het harde werk van ontwikkelaars wereldwijd. Ben je fan van Immich? Overweeg dan om bij te dragen of het project te steunen!

Veel plezier met het beheren van je foto’s!

(coverfoto door Douglas lopez