API - bestanden

Aan G!DS items kunnen bestanden zijn toegevoegd. Dit kunnen uiteenlopende bestanden zijn, maar het zijn voornamelijk afbeeldingen en documenten.

Met name het gebruik van afbeeldingen vereist extra aandacht. Daarvoor hebben we in de middleware een extra commando gemaakt om de afbeeldingen vanuit G!DS goed te kunnen gebruiken. Dit commando biedt mogelijkheden voor een uniforme weergave van verschillende formaten, en snelheidswinst.

We hebben gekozen voor drie vormen, een vierkante, een langwerpige en een brede weergaven. In de middleware omgeving kunnen meerdere samenstellingen gemaakt worden. Door de samenstelling in de middleware vast te leggen, en bij het tonen van de afbeeldingen deze te gebruiken wordt het van tevoren duidelijk hoe groot de afbeelding is. Daarbij is het niet nodig om de exacte maten op te geven, het is ook mogelijk om alleen de breedte of de hoogte vast te stellen.

Commando url samenstelling

De url voor dit speciale url-commando is uitgebreider dan de overige url-commando's. De volgende onderdelen zijn nodig:

file

Dit zorgt voor het activeren van bestands afhandelins component.

view

De gewenste actie voor het geselecteerde bestand. Op dit moment is alleen 'view' geïmplementeerd.

[GIDS_TYPE]

Hiermee kan worden aangegeven voor welk onderdeel het bestand moet worden gestuurd. Het gaat hier om de G!DS types: (product, organisatie en hyperlink)

[ITEM_ID]

Identificatie sleutel van het G!DS item (product/organisatie/hyperlink).

img

Dit veld geeft expliciet dat we hier op zoek zijn naar een bestand van het type 'afbeelding'.

[INDEX]

Er kunnen meerdere afbeeldingen bij een G!DS-item zijn toegevoegd, aan de hand van de index kan een keuze gemaakt worden.

Daarnaast zijn er ook nog aanvullende parameters:

Parameters

Naam	Beschrijving	Verplicht
apikey	Unieke identificatiesleutel van de applicatie, wordt gebruikt voor het ophalen van de juiste data en het bijhouden van het gebruik van de applicatie.	Ja
thumb_id	Unieke code uit de middleware van G!DS afbeelding formaat. Zonder 'thumb_id' wordt de originele afbeelding geleverd.	Nee

Bij de uitvoer van de gegevens bij zoeken, detail en uitgelicht selecties komt standaard een url die samengesteld is voor de afbeelding. Deze voegen we extra toe aan de uitvoer van een G!DS-item. Hier hoeft alleen een 'thumb_id' aan te worden toegevoegd.

In de afmetingen voor de thumbnail is ingesteld dat het een 'hoge' afbeelding moet zijn met een maximale breedte van 200px. De hoogte wordt berekend op basis van de afmetingen van de originele afbeelding.

In dit voorbeeld wordt een uitsnede gemaakt van de gekozen afbeelding met de maximale breedte en hoogte van 100px.