Documentatie

Blog API

Met de URLs die hieronder beschreven worden kunnen blog-gegevens opgehaald worden van een specifieke site. De gegevens worden hierbij teruggegeven in JSON-formaat. Voor het aanroepen van een URL is altijd een API-key nodig, die u als het goed is van ons hebt gekregen. De API is 32 tekens lang en bestaat uit alleen letters (a-f) en cijfers.

In de voorbeelden hieronder wordt de API aangeroepen op het domein https://instrumentatie.hitma.addsite.io. Dit domein kan gebruikt worden om alle blogs van HITMA Instrumentatie op te halen. Voor de blogs van HITMA Gebouwautomatisering kunnen dezelfde URLs gebruikt worden, maar dan met het domein https://gebouwautomatisering.hitma.addsite.io.

Overzicht van blogs

Het overzicht van blogs wordt opgehaald in pagina's. Standaard worden er 20 blogs tegelijk opgehaald, maar dit aantal is aan te passen in de URL. De blogs worden opgehaald gesorteerd op publicatiedatum, de meest recente eerst.

/api/blog?key=API_KEY{&page=PAGINA}{&limit=AANTAL_PER_PAGINA}

Bijvoorbeeld:

URL	Toont
`/api/blog?key=API_KEY`	De eerste pagina met blogs
`/api/blog?key=API_KEY&page=2`	De tweede pagina met blogs
`/api/blog?key=API_KEY&limit=50`	De eerste 50 blogs i.p.v. de eerste 20
`/api/blog?key=API_KEY&page=3&limit=25`	De derde pagina met blogs o.b.v. 25 blogs per pagina

De meest basale URL geeft dus de eerste 20 blogs terug. Door de parameter page aan te passen zijn andere pagina's op te halen en door de parameter limit aan te passen is het aantal blogs per pagina aan te passen. Hieronder volgt een voorbeeld van de gegevens die teruggegeven worden. Let op dat er een veld data is, die alle blogs bevat en een veld pages met alle nodige informatie over de paginering.

https://instrumentatie.hitma.addsite.io/api/blog?key=API_KEY

{
    "data": [
        {
            "id": "6105",
            "publish_date": "2019-03-04 13:52:00",
            "archive_date": null,
            "settings": {
                "fulltext_extra": "",
                "follup_caption": "",
                "followup_title": "",
                "followup_open_modal": false,
                "reading_time": "3",
                "first_photo_align": "right",
                "first_photo_width": 33,
                "slideshow": false,
                "slideshow_thumbs": false,
                "photo_enlarge": true,
                "quote_style": "with_quotes",
                "videolink": "",
                "html": ""
            },
            "tags": "",
            "created": "2019-03-04 13:52:00",
            "modified": "2020-06-03 15:15:58",
            "headline": "Is er een oplossing voor condensatieproblemen bij ultrasone sensoren?",
            "introtext": "Condensatie is de meest voorkomende variabele bij het meten van een vloeistofniveau met behulp van ultrasone sensoren. En condensatie is zeker iets om serieus rekening mee te houden, want het verslechtert de meetbetrouwbaarheid van specifieke ultrasone sensoren. Veel gebruikers kiezen daarom voor duurdere radarsensoren om condensatieproblemen aan te pakken. Begrijpelijk, maar dat is tegenwoordig gelukkig niet meer nodig door de ontwikkeling van reflectie ultrasone sensoren.",
            "followup_url": "https://www.hitma-instrumentatie.nl/nl/blog-nl/is-er-een-oplossing-voor-condensatieproblemen-bij-ultrasone-sensoren",
            "thumbnail": "https://instrumentatie.hitma.addsite.io/previews/2019/3/4/media_28_2881_w600_h320_crop.jpg",
            "total_media": 1,
            "total_documents": 0,
            "total_images": 1,
            "total_videos": 0,
            "total_audios": 0,
            "total_texts": 0,
            "total_unknown": 0,
            "locale": null,
            "url": "https://instrumentatie.hitma.addsite.io/api/blog/2019/03/6105-is-er-een-oplossing-voor-condensatieproblemen-bij-ultrasone-sensoren",
            "user": {
                "id": "75",
                "name": "Ronald Vonk",
                "email": "",
                "url": "/api/blog/archive/user/75"
            }
        },
        ...
    ],
    "pages": {
        "pageCount": 1,
        "itemCountPerPage": 20,
        "first": 1,
        "current": 1,
        "last": 1,
        "pagesInRange": {
            "1": 1
        },
        "firstPageInRange": 1,
        "lastPageInRange": 1,
        "currentItemCount": 3,
        "totalItemCount": 3,
        "firstItemNumber": 1,
        "lastItemNumber": 3
    }
}

Archief

Voor HITMA blogs heeft het de voorkeur om het archief o.b.v. tags te tonen op www.hitma.nl. Verwijs hiervoor de bezoeker door naar https://www.hitma.nl/blog?created_by[]=GEBRUIKER_ID

Er kan in de blogs gezocht worden o.b.v. tags, auteurs of maand. Het resultaat voor onderstaande URL's komt in dezelfde vorm als het overzicht: een veld 'data' met alle blogs en een veld 'pages' met pagineringsinfo.

/api/blog/archive/user/GEBRUIKER_ID?key=API_KEY{&page=PAGINA}{&limit=AANTAL_PER_PAGINA}
/api/blog/archive/tag/TAG?key=API_KEY{&page=PAGINA}{&limit=AANTAL_PER_PAGINA}
/api/blog/archive/JAAR/MAAND?key=API_KEY{&page=PAGINA}{&limit=AANTAL_PER_PAGINA}

Bijvoorbeeld:

URL	Toont
`/api/blog/archive/user/75?key=API_KEY`	De blogs geschreven door gebruiker met ID 75
`/api/blog/archive/tag/procesindustrie?key=API_KEY`	De blogs met de tag 'procesindustrie'
`/api/blog/archive/2021/3?key=API_KEY`	De blogs van maart 2021

Blog detail

Het is mogelijk om voor een specifieke blog alle details op te halen. Dit bevat alle gegevens die ook in het overzicht terugkomen, aangevuld met deze gegevens:

Opmaakinstellingen (het veld settings)
De volledige broodtekst (het veld fulltext)
Alle afbeeldingen en documenten die aan de blog gekoppeld zijn (het veld media)

Om alle details van een enkele blog op te halen, kan een URL van het volgende formaat gebruikt worden.

/api/blog/JAAR/MAAND/ID-SLUG?key=API_KEY

De URL's zijn ook altijd terug te vinden in de blog-overzichten. Let wel dat hier altijd de parameter key aan toegevoegd moet worden om toegang te krijgen tot de details.

Bijvoorbeeld:

https://instrumentatie.hitma.addsite.io/api/blog/2019/03/6105-is-er-een-oplossing-voor-condensatieproblemen-bij-ultrasone-sensoren?key=API_KEY

Onderstaand voorbeeld toont hoe de gegevens teruggegeven worden:

{
    "id": "6105",
    "publish_date": "2019-03-04 13:52:00",
    "archive_date": null,
    "settings": {
        "fulltext_extra": "",
        "follup_caption": "",
        "followup_title": "",
        "followup_open_modal": false,
        "reading_time": "3",
        "first_photo_align": "right",
        "first_photo_width": 33,
        "slideshow": false,
        "slideshow_thumbs": false,
        "photo_enlarge": true,
        "quote_style": "with_quotes",
        "videolink": "",
        "html": ""
    },
    "tags": "",
    "created": "2019-03-04 13:52:00",
    "modified": "2020-06-03 15:15:58",
    "headline": "Is er een oplossing voor condensatieproblemen bij ultrasone sensoren?",
    "introtext": "Condensatie is de meest voorkomende variabele bij het meten van een vloeistofniveau met behulp van ultrasone sensoren. En condensatie is zeker iets om serieus rekening mee te houden, want het verslechtert de meetbetrouwbaarheid van specifieke ultrasone sensoren. Veel gebruikers kiezen daarom voor duurdere radarsensoren om condensatieproblemen aan te pakken. Begrijpelijk, maar dat is tegenwoordig gelukkig niet meer nodig door de ontwikkeling van reflectie ultrasone sensoren.",
    "fulltext": "<p>Condensatie is de meest voorkomende variabele bij het meten van een vloeistofniveau met behulp van ultrasone sensoren.</p> <p>En condensatie is zeker iets om serieus rekening mee te houden, want het verslechtert de meetbetrouwbaarheid van specifieke ultrasone sensoren. Veel gebruikers kiezen daarom voor duurdere radarsensoren om condensatieproblemen aan te pakken. Begrijpelijk, maar dat is tegenwoordig gelukkig niet meer nodig door de ontwikkeling van reflectie ultrasone sensoren.</p>",
    "followup_url": "https://www.hitma-instrumentatie.nl/nl/blog-nl/is-er-een-oplossing-voor-condensatieproblemen-bij-ultrasone-sensoren",
    "thumbnail": "https://instrumentatie.hitma.addsite.io/previews/2019/3/4/media_28_2881_w600_h320_crop.jpg",
    "total_media": 1,
    "total_documents": 0,
    "total_images": 1,
    "total_videos": 0,
    "total_audios": 0,
    "total_texts": 0,
    "total_unknown": 0,
    "locale": null,
    "media": [
        {
            "title": "Een foto",
            "alt": "Dit is een foto",
            "description": null,
            "mimetype": "image/jpeg",
            "sizes": [
                {
                    "width": 1200,
                    "height": 801,
                    "url": "https://instrumentatie.hitma.addsite.io/previews/2021/3/22/media_1_7_w1200_fit.jpg"
                },
                {
                    "width": 410,
                    "height": 182,
                    "url": "https://instrumentatie.hitma.addsite.io/previews/2021/3/22/media_1_7_w410_h182_crop.jpg"
                }
            ]
        },
        {
            "title": "Een Word-bestand",
            "filename": "ditiseenwordbestand.doc",
            "size": "19456",
            "mimetype": "application/msword",
            "download_url": "https://instrumentatie.hitma.addsite.io/site/download/06mQHz1qrnyt"
        },
        {
            "title": "Een PDF-bestand",
            "filename": "ditiseenpdfbestand.pdf",
            "size": "76002",
            "mimetype": "application/pdf",
            "download_url": "https://instrumentatie.hitma.addsite.io/site/download/1JJ40JivkhV3"
        }
    ],
    "url": "https://instrumentatie.hitma.addsite.io/api/blog/2019/03/6105-is-er-een-oplossing-voor-condensatieproblemen-bij-ultrasone-sensoren",
    "user": {
        "id": "75",
        "name": "Ronald Vonk",
        "email": "",
        "url": "/api/blog/archive/user/75"
    }
}

Het settings veld

Het veld settings bij een blog bevat alle opmaakinstellingen. Hieronder een overzicht van alle velden met hun uitleg

Veld	Omschrijving	Inhoud
`fulltext_extra`	Extra broodtekst	html
`followup_caption`	De tekst die in de doorlink (followup_url) moet komen te staan
`followup_title`	De titel-tag die in boven de doorlink (followup_url) moet komen
`followup_open_modal`	Geeft aan of de doorlink in een modal / popup moet worden geopend	`true` of `false`
`reading_time`	De geschatte leestijd van de blog in minuten
`first_photo_align`	De uitlijning van de eerste foto in de blog	'right', 'left' of 'top'
`first_photo_width`	De breedte van de eerste foto in de blog (percentage)	25, 33, 50, 75 of 100
`slideshow`	Geeft aan of de afbeeldingen in een slideshow moeten worden getoond	`true` of `false`
`slideshow_thumbs`	Geeft aan of er thumbnails bij de slideshow moeten worden getoond (alleen geldig als slideshow op true staat)	`true` of `false`
`photo_enlarge`	Geeft aan of er de mogelijkheid moet zijn om afbeeldingen te vergroten	`true` of `false`
`quote_style`	De stijl van quotes in de blog	'with_quotes' (Met aanhalingtekens) of 'with_border_left' (Met lijn aan de linkerkant)
`videolink`	URL naar een YouTube- of Vimeo-video
`html`	Extra HTML, zoals insluitcodes etc.

Voorbeeld HTML

Er is een voorbeeld beschikbaar van hoe de blogs er in HTML uit kunnen zien, met onafhankelijke stylesheets. Deze is hier te vinden: Voorbeeld HTML voor blogs. De pagina bevat achtereenvolgens:

Een detailpagina
Een overzichtspagina met paginering

Inhoud