Billeder gennem API’et

Siden version 0.7.5 af Uddata API’et er det muligt at importere billeder til vores studieløsning: Uddataplus.API’et understøtter nu to endpoints:

  1. GET /billeder/{cpr}
  2. PUT /billeder?cpr=xxxxxxyyyy&billede=binary-file

Fremgangsmåde

For at kunne bruge API’et kræves det som sædvanligt, at man har en valid token.

Enhver bruger af API’et kan selv implementere en løsning, der kan sende billederne til Uddata API’et – Hvis dette ikke ønskes, har vi implementeret en simpel Java løsning, som skal startes lokalt. Download her: image-uploader

OBS: Det kræves, at jeres API credentials har rettighed til at uploade billeder. Kontakt support for at anmode om adgang til at kunne uploade billeder gennem API’et.

Brug af image-uploader

Når du har downloadet image-uploader.zip skal du eksportere den indeholdte fil: image-uploader.jar. Denne fil gør det muligt at sende alle billeder direkte til Uddata API’et.

For at kunne bruge java filen kræves det, at computeren har Java installeret. En gratis version af Java kan installeres herfra: https://docs.aws.amazon.com/corretto/latest/corretto-8-ug/what-is-corretto-8.html

Konkret fremgangsmåde:

  1. eksportér jar filen
  2. opret en mappe, hvor alle billeder, som skal importeres ligger
    1. Alle billeder “kan” være navngivet i dette format: <cpr>.jpg. Eksempel: 1234561234.jpg eller 123456-1234.jpg, hvis man vælger cpr som <identifier>
    2. Alle billeder “kan” være navngivet i dette format: <unilogin>.jpg. Eksempel: xx1234.jpg, hvis man vælger unilogin som <identifier> – Dette virker kun for elever indtilvidere.
  3. kopier image-uploader.jar filen ind i samme mappe, hvor alle billederne ligger.
  4. Åben en terminal i mappen
  5. Kør kommando: java -jar image-uploader.jar <miljø> <institutionsnummer> <api_version> <client_id> <client_secret> <identifier(cpr eller unilogin)>

    1. Eksempel med cpr som identifier: java -jar image-uploader.jar production 123456 0.7.5 my.ist.api_client.id 1f23e2f1e2f3saf1e3f51s3f51es351fes31fse32f1e3s1f cpr
    2. Eksempel med unilogin som identifier: java -jar image-uploader.jar production 123456 0.7.5 my.ist.api_client.id 1f23e2f1e2f3saf1e3f51s3f51es351fes31fse32f1e3s1f unilogin

Nu vil Java programmet begynde at uploade alle billederne, der findes i mappen. Hver gang .jar filen startes, lægges der en <tidsstempel>.log fil ved siden af .jar filen, som indeholder alle logs fra den gældende eksekvering.

Statuskoder:

  • 404 betyder, at identifieren ikke ikke linkes til et individ i databasen og derfor kunne billedet ikke uploades.
  • 401 betyder, at jeres api credentials ikke er gyldige.
  • 403 betyder, at jeres api credentials ikke har de rigtige rettigheder.
  • 201 betyder, at billedet blev uploadet korrekt.