API Documentatie

Hoe te verbinden met de Good 4 Service API

De Good 4 Service API is ontwikkeld om het voor resellers van brillen en hoortoestellen eenvoudig mogelijk te maken hun klanten een leaseplan aan te bieden. Op deze pagina vindt u een stap voor stap uitleg over hoe de API werkt en hoe deze binnen uw systeem geimplementeerd kan worden. Voor vragen of opmerkingen kunt u contact opnemen.

Het endpoint om mee te verbinden is

https://platform.good4service.nl/api/v1/

Test API Key:
Voor ontwikkeling en testen van onze API kunt u gebruik maken van een test API key, de test key is "TEST-G4S-TEST-G4S".

Live API Key:
Om te verbinden met het platform van Good 4 Service is een API key vereist. Deze key kunt u ontvangen door contact met ons op te nemen.

Stuur de API key mee in de header van al uw requests als X-Api-Key.

JSON:

{
  "url": "https://platform.good4service.nl/api/v1/",
  "method": "GET",
  "headers": {
    "X-Api-Key": "your_api_key_here"
  }
}

Hieronder vindt u een schematische weergave van de werking van de Good4Service API tussen de verschillende partijen (klant, reseller en Good4Service).

Om een order correct te plaatsen via de API zijn de onderstaande gegevens nodig.

Belangrijk: Voor de categorie per orderregel is het van belang "glasses" voor brillen, "hearing" voor hoortoestellen of "proefperiode" voor enkel een kredietcheck te gebruiken. Andere waardes zijn toegestaan maar deze triggeren niet de routine die kredietcheck uitvoert en contract opstelt.

JSON

{
  "url": "https://platform.good4service.nl/api/v1",
  "method": "POST",
  "headers": {
    "X-Api-Key": "your_api_key_here"
  },
  "body": {
    "ID_check":"{id_check}",
    "test":
    {
        "test_modus":"{test_modus}",
        "credit_score":"{credit_score}"
    },
    "store_id":"{store_id}",
    "employee_name":"{employee_name}",
    "applicant":
    {
        "gender":"{gender}",
        "first_name":"{first_name}",
        "last_name":"{last_name}",
        "street":"{street}",
        "housenumber":"{housenumber}",
        "extra":"{extra}",
        "postal_code":"{postal_code}",
        "city":"{city}",
        "country":"{country}",
        "email_address":"{email_address}",
        "phone_number":"{phone_number}",
        "iban":"{iban}",
        "birthdate":"{birthdate}"
    },
    "user":
    {
        "other_user":"{other_user}",
        "first_name":"{user_first_name}",
        "last_name":"{user_last_name}",
        "relation":"{relation}"
    },
    "order":
    {
        "order_id":"{order_id}",
        "order_nr":"{order_nr}",
        "bookdate":"{bookdate}",
        "order_items":[
            {
                "category":"{item1_category}",
                "item_code":"{item1_code}",
                "articlenr":"{item1_articlenr}",
                "description":"{item1_description}",
                "price":"{item1_price}"
            },
             {
                "category":"{item2_category}",
                "item_code":"{item2_code}",
                "articlenr":"{item2_articlenr}",
                "description":"{item2_description}",
                "price":"{item2_price}"
            }
        ],
        "discount":"{discount}",
        "customer_totalprice":"{customer_totalprice}",
        "down_payment":"{down_payment}"
    }
  }
}

Bepaal het maandbedrag van een leaseplan door een totaalprijs en categorie mee te geven.

URL

https://platform.good4service.nl/api/v1/calculate

JSON

{
  "url": "https://platform.good4service.nl/api/v1/calculate",
  "method": "POST",
  "headers": {
    "X-Api-Key": "your_api_key_here"
  },
  "body": {
    "totalprice": "{total_price}",
    "quantity": "{quantity}",
    "category": "{category}",
    "down_payment": "{down_payment}"
   } 
}

Een leascontract gaat in op het moment dat de klant zijn producten heeft ontvangen. Voor brillen is een aparte terugkoppeling van de afhaaldatum vereist. Voor hoortoestellen geldt de datum van ondertekenen van het leasecontract. Hier is dus geen terugkoppeling voor nodig.

URL

https://platform.good4service.nl/api/v1/pickup

De afhaaldatum wordt toegevoegd door in de body van de POST naar de api het volgende toe te voegen:

"pickup_date": "2024-12-12T13:00:08"

Houd rekening met een juiste datum/tijd notatie.

JSON

{
  "url": "https://platform.good4service.nl/api/v1/status",
  "method": "POST",
  "headers": {
    "X-Api-Key": "your_api_key_here"
  },
  "body": {
    "order_id": "TESTORDER-1234-5678-ABCD-1234567890",
    "pickup_date": "2024-12-12T13:00:08"
  }
}

Om de status van een order op te vragen gebruik:

https://platform.good4service.nl/api/v1/status

Stuur uw unieke order UID mee.

{
    "order_id": "TESTORDER-1234-5678-ABCD-1234567890"
}

Mogelijke statussen:

JSON

{
  "url": "https://platform.good4service.nl/api/v1/status",
  "method": "POST",
  "headers": {
    "X-Api-Key": "your_api_key_here"
  },
  "body": {
    "order_id": "TESTORDER-1234-5678-ABCD-1234567890"
  }
}