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-1.0.0

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-1.0.0

Når du har downloadet image-uploader-1.0.0.zip skal du eksportere den indeholdte fil: image-uploader-1.0.0.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. Java kan installeres herfra: https://www.java.com/en/download/

Konkret fremgangsmåde:

  1. eksportér jar filen
  2. opret en mappe, hvor alle billeder, som skal importeres ligger
    1. Alle billeder skal være navngivet i dette format: <cpr>.jpg. Eksempel: 1234561234.jpg
  3. kopier image-uploader-1.0.0.jar filen ind i samme mappe, hvor alle billederne ligger.
  4. Åben en terminal i mappen
  5. Kør kommando: java -jar image-uploader-1.0.0.jar <miljø> <institutionsnummer> <api_version> <client_id> <client_secret>
    1. Eksempel: java -jar image-uploader-1.0.0.jar production 123456 0.7.5 my.ist.api_client.id 1f23e2f1e2f3saf1e3f51s3f51es351fes31fse32f1e3s1f

Nu vil Java programmet begynde at uploade alle billederne, der findes i mappen. Hvis der opstår fejl, vil loggen fra terminalen vise, at noget gik galt og hvorfor.

Statuskoder:

  • 404 betyder, at cpr ikke ikke findes 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.