Optioneel direct goedkeuren vanuit publieke API

Algemeen goedkeuren vanuit publieke API

Iedere aanvraag die wordt gedaan (ingeschoten) via de publieke API komt standaard terecht bij 'openstaande aanvragen'. Zie ook dit artikel.

Het is nu ook mogelijk om op bepaalde voorwaarden deze direct goed te keuren, waarna deze boeking (dat is een cursist/deelnemer/student) direct inclusief communicatie, factuurregels etc wordt ingepland in de bedoelde cursus.

Deze optie staat standaard uit en dient door de 'superadmin' zelf actief te worden gemaakt. Zie ook 'Voorbereiding hieronder bij 'werkwijze'.

Hoe het werkt

Indien actief gezet door 'superadmin' wordt er op basis van voorwaarden een beslissing genomen of de boeking (booking) via de publieke API direct goedgekeurd moet worden. Hiermee wordt bedoeld dat de 'handmatige actie' 'goedkeuren' automatisch wordt overgeslagen indien je dat wil.

Dit zijn aanmeldingen die binnenkomen via de Publieke API, waarbij de Wordpress plugin (Planaday-API) hier ook gebruik van maakt.

Voorwaarden

• Publieke API moet actief zijn, zie hier en hier voor de documentatie van de API
• Een API-key, zie hier

Uitzonderingen

• Alle cursussen met daarin code95 (optioneel voor transport branche) valt standaard in 'uitvalbakje' en zal 'met de hand goedgekeurd moeten worden
• Alle cursussen met daarin soob (optioneel voor transport branche) valt standaard in 'uitvalbakje' en zal 'met de hand goedgekeurd moeten worden

Werkwijze & activeren

Standaard staat de optie 'automatisch goedkeuren' UIT!

Direct goedkeuren actief zetten

Zet automatisch goedkeuren aan. Onderneem de volgende stappen:

1. Ga naar 'beheer -> instellingen'
2. Kies voor 'Publieke API' bij 'Publieke pagina's, API & Portals' indien actief
3. Zet 'direct goedkeuren' op 'ja' als je deze actief wil hebben

Hier stel je eenvoudig in dat 'direct goedkeuren' actief is. Standaard is 'Boeking is betaald' al gekozen

Extra voorwaarden bij goedkeuren

De boekingen die binnenkomen via de API worden goedgekeurd op basis van 3 elementen indien deze op 'ja' (is actief) staat. Er is een combinatie van onderstaande mogelijk! 

1. Is de boeking betaald
2. Is bedrijf al bekend en gecontroleerd = ja (ingeval van particulier zal deze genegeerd worden)
3. Is cursist al bekend en eerder gecontroleerd = ja

Het is aan de gebruiker van Planaday de keuze welke je wel of niet actief maakt. Iedere voorwaarde die wordt aangevinkt zorgt ervoor dat een boeking NIET worden goedgekeurd als er NIET aan alle geselecteerde voorwaarden wordt voldaan.

Bij 'voorbeelden' worden enkele voorbeelden uitgelegd.

Extra instelling bij bedrijf (niet goedkeuren)

Je kunt ervoor kiezen om voor de gehele Planaday omgeving 'direct goedkeuren' actief te hebben en voor enkele 'bekende bedrijven' deze NIET actief te hebben. 

Voor de bedrijven waarvoor je deze uitzondering wil onderneem je de volgende stappen:

1. Zoek bedrijf op en klik op 'bewerk'
2. Kies voor tabblad 'Instellingen'
3. Geef hier je voorkeur 'Direct goedkeuren' op
4. Klik op opslaan

Bewerkscherm bij bedrijf

Let op: Standaard zal ieder bedrijf op 'ja' staan indien 'direct goedkeuren' ook op 'ja' (dus actief) staat.

Voorbeelden 'Extra voorwaarden'

Boeking is betaald, rest niet gekozen (standaard)

Bij deze instelling zal iedere boeking die binnenkomt via de Publike API met 'is_payed': true direct worden goedgekeurd.

Ook als de andere opties van toepassing zijn worden deze genegeerd. Want er is tenslotte betaald en dat is een voorwaarde.

Iedere boeking waarbij 'is_payed': false is zal niet direct worden goedgekeurd en komt in de lijst met 'openstaande aanvragen'. Deze zal 'met de hand' goedgekeurd moeten worden. Zie ook dit artikel.

Geen voorwaarde gekozen (let op!)

Bij deze instelling zal iedere boeking ongeacht of deze wel of niet betaald is direct worden goedgekeurd. Ook van bedrijven en/of cursisten die niet bekend zijn in Planaday worden deze boekingen meteen in de gekozen cursus ingepland.

Let op: Wij adviseren jou deze instelling niet.

Boeking is betaald, bedrijf moet bekend zijn, rest niet gekozen

Bij deze instelling zal iedere boeking die binnenkomt via de Publike API met 'is_payed': true direct worden goedgekeurd indien het bedrijf ook bekend is in Planaday en ook 'gecontroleerd' is (= eerder goedgekeurd).

Ook als de andere opties van toepassing zijn worden deze genegeerd. Want er is tenslotte betaald en bedrijf is bekend en dat zijn de voorwaarden.

Iedere boeking waarbij 'is_payed' false of het bedrijf onbekend of niet goedgekeurd is, zal niet direct worden goedgekeurd en komt in de lijst met 'openstaande aanvragen'. Deze zal 'met de hand' goedgekeurd moeten worden. Zie ook dit artikel.

Alle voorwaarden zijn actief

Bij deze instelling zal iedere boeking die binnenkomt via de Publike API met 'is_payed': true direct worden goedgekeurd indien het bedrijf EN cursist ook bekend is in Planaday. Beide moeten dan ook 'gecontroleerd' zijn (= eerder goedgekeurd)

Iedere boeking waarbij 'is_payed' false is en/of het bedrijf en/of de crusist onbekend zal niet direct worden goedgekeurd en komt in de lijst met 'openstaande aanvragen'. Deze zal 'met de hand' goedgekeurd moeten worden. Zie ook dit artikel.

Deze optie is de 'meest veilige' om direct goedkeuren te gebruiken, hiermee voorkomt je ook de meeste vervuiling in het systeem.

Handig overzicht

Er zijn veel afhankelijkheden en om niet het overzicht te verliezen hebben wij een 'dashboard' gemaakt waarin je snel een overzicht hebt van de instellingen voor 'direct goedkeuren' en wat wel en niet actief is.

Lees hier alles over deze instellingen.

Handig om te weten

Van iedere boeking die binnenkomt en direct wordt goedgekeurd wordt het volgende gedaan:

• Er wordt een notitie gemaakt bij bedrijf en/of cursist
• Er wordt (indien actief) een openstaande factuurregel gemaakt
• Er wordt communicatie aangemaakt volgens instellingen

Voorbeelden boekingen in code

Hieronder enkele voorbeelden om een idee te geven van een API call (zie ook de API documentatie)

Voorbeeld boeking bedrijf met cursist wel betaald:

{
    "students": [
        {
            "gender": "m",
            "first_name": "meneer",
            "last_name": "Appel",
            "email": "appel@planaday.nl",
            "address": null,
            "house_number": null,
            "house_number_extension": null,
            "postal_code": null,
            "city": null,
            "phonenumber": null,
            "date_of_birth": null
        }
    ],
    "company": {
        "name": "Groentehandel BV",
        "email": null,
        "address": "Obrechtstraat",
        "house_number": "94",
        "house_number_extension": null,
        "postal_code": "2517VW",
        "city": "s-Gravenhage",
        "phonenumber": null
    },
    "notes": "",
    "created_at": "2021-06-14T19:17:07+00:00",
    "creating_source": "test site",
    "course_id": 1,
    "is_payed": true,
    "payment": {
        "party": "Ideal",
        "transaction_id": "123123sdfsdfA"
    }
}

{
    "students": [
        {
            "gender": "m",
            "first_name": "Pieter",
            "last_name": "Pietersen",
            "email": "pieter@pietersen.nl",
            "address": "Straat",
            "house_number": "1",
            "house_number_extension": null,
            "postal_code": "2132PS",
            "city": "Hoofddorp",
            "phonenumber": null,
            "date_of_birth": null
        }
    ],
    "company": {
        "name": "Pietersen BV",
        "email": "klara@pietersen.nl",
        "address": "Straat",
        "house_number": "1",
        "house_number_extension": null,
        "postal_code": "2132PS",
        "city": "Hoofddorp",
        "phonenumber": null
    },
    "notes": "",
    "created_at": "2021-06-14T19:17:07+00:00",
    "creating_source": "test site",
    "course_id": 1,
    "is_payed": false
}

Voorbeeld boeking cursist zonder bedrijf niet betaald:

{
    "students": [
        {
            "gender": "m",
            "first_name": "Pieter",
            "last_name": "Pietersen",
            "email": "pieter@pietersen.nl",
            "address": "Straat",
            "house_number": "1",
            "house_number_extension": null,
            "postal_code": "2132PS",
            "city": "Hoofddorp",
            "phonenumber": null,
            "date_of_birth": null
        }
    ],
    "notes": "",
    "created_at": "2021-06-14T19:17:07+00:00",
    "creating_source": "test site",
    "course_id": 1,
    "is_payed": false
}

{
    "students": [
        {
            "gender": "m",
            "first_name": "Pieter",
            "last_name": "Pietersen",
            "email": "pieter@pietersen.nl",
            "address": "Straat",
            "house_number": "1",
            "house_number_extension": null,
            "postal_code": "2132PS",
            "city": "Hoofddorp",
            "phonenumber": null,
            "date_of_birth": null
        }
    ],
    "notes": "",
    "created_at": "2021-06-14T19:17:07+00:00",
    "creating_source": "test site",
    "course_id": 1,
    "is_payed": true,
    "payment": {
        "party": "Ideal",
        "transaction_id": "123123sdfsdfA"
    }
}

Handige links

• Bekijk de huidige API-docs, zie hier
• Hoe vraag je publieke API aan, zie hier
• Hoe koppel je Wordpress aan publieke API, zie hier
• Hoe werken 'openstaande aanvragen' zie hier

Beslissings-flow

Wij hebben een beslissingsflow gemaakt (zie download hieronder (FlowDirectGoedkeuren.pdf). Deze geeft visueel weer hoe er wordt besloten tot een boeking of tot een controle bij 'openstaande aanvragen'.