Care4Fresh API

De Care4Fresh API is een REST-API waarmee u gegevens uit een administratie in de Care4Fresh- of Care4Commerce-cloudomgeving kunt raadplegen en verwerken, zoals artikelen, prijzen, relaties, verkooporders en voorraad.

Tip: De volledige documentatie met alle endpoints vindt u op https://cloud.care4it.nl/api/docs/. Dit is altijd de meest actuele bron.

Wat kan ik met de API?

De API biedt onder andere toegang tot de volgende gegevens:

• Artikelen: zoeken en ophalen op id, code of barcode, met varianten (verpakkingen en samenstellingen), artikelgroepen en hoofdartikelgroepen, eenheden, BTW-tarieven, magazijnen en artikellocaties.
• Prijzen: geldende verkoopprijzen (algemeen en klantspecifiek), prijswijzigingen, kortingen en aanbiedingen, en assortiments- en bestellijsten.
• Relaties: klanten en leveranciers zoeken en ophalen (op id, code, debiteur- of crediteurnummer), met adressen, contactpersonen en klantcategorieën.
• Verkoop: verkooporders zoeken en opvragen, nieuwe verkooporders aanmaken, de status wijzigen en geleverde aantallen bijwerken.
• Voorraad: voorraad per locatie en per inkoopregel, inclusief traceerbaarheid.

Tip: Voor koppelingen die periodiek gegevens ophalen, ondersteunt de API het ophalen van alleen de wijzigingen sinds een bepaald tijdstip (incrementele synchronisatie). Zo hoeft u niet telkens de volledige gegevensset opnieuw te lezen.

Toegang en API-sleutel

Elke aanvraag wordt geauthenticeerd met een API-sleutel via de header X-Api-Key. U beheert uw API-sleutels zelf in het portaal.

Belangrijk: API-toegang moet eerst eenmalig door de Helpdesk van Care4iT voor uw administratie worden geactiveerd. Pas daarna kunt u zich in het portaal aanmelden en een API-sleutel aanmaken. Wilt u een externe partij toegang geven, bijvoorbeeld een bedrijf dat uw webshopkoppeling verzorgt? Die partij wordt door Care4iT geregistreerd en krijgt toegang tot uw administratie. Neem contact op om dit te regelen.

1. Ga naar het portaal op https://cloud.care4it.nl/api/portal/.

2. Meld u aan met uw e-mailadres. U ontvangt een eenmalige inloglink.

3. Maak een API-sleutel aan en bewaar deze veilig (de sleutel wordt eenmalig getoond).

4. Gebruik de API-basis-URL https://cloud.care4it.nl/api met uw sleutel in de header X-Api-Key.

   

Belangrijk: Een API-sleutel geeft toegang tot de administraties waartoe u gemachtigd bent en neemt uw rol over. De sleutel kan niet meer toegang geven dan u zelf heeft.

Abonnement

Het gebruik van de API valt onder een abonnement met een maandelijks aantal aanvragen. In het portaal kunt u uw abonnement bekijken, afsluiten of wijzigen.

AI-assistent koppelen

AI-assistenten zoals Claude kunnen de Care4Fresh API namens u gebruiken, zonder dat u een API-sleutel hoeft te delen. Dit verloopt via de MCP-standaard (Model Context Protocol), met een aanmeld- en toestemmingsstap.

1. Voeg in de assistent een aangepaste MCP-server toe met de URL https://cloud.care4it.nl/api/mcp.
2. U krijgt een Care4Fresh-aanmeldscherm met een toestemmingsvraag. Meld u aan met uw e-mailadres om de koppeling goed te keuren.
3. De assistent kan daarna gegevens raadplegen en, als u dat toestaat, verkooporders aanmaken.

Tip: Een gekoppelde assistent beheert of verwijdert u op elk moment via Account > Connected apps in het portaal. Zie de API-documentatie voor instellingen per assistent, zoals Claude, ChatGPT en Gemini.