Care4Fresh API

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

Tip: De volledige documentatie met alle endpoints vind je op https://cloud.care4it.nl/api/docs/. Dit is altijd de meest actuele bron. Wat er recent aan de API is toegevoegd of gewijzigd, lees je in het wijzigingsoverzicht.

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. De klantspecifieke prijzen worden dagelijks berekend. Zie Wanneer worden de klantspecifieke prijzen bijgewerkt? als je een prijswijziging eerder beschikbaar wilt hebben.
  • Relaties: klanten en leveranciers zoeken en ophalen (op id, code, debiteur- of crediteurnummer), met adressen, contactpersonen, klantcategorieën en relatietypen en -groepen.
  • Verkoop: verkooporders zoeken en opvragen, nieuwe verkooporders aanmaken, de status wijzigen en geleverde aantallen bijwerken.
  • Inkoop: inkooporders zoeken en opvragen, met de leverancier, de datums, de status en de ordertotalen, en per regel de prijzen, kortingen en de bestelde en ontvangen aantallen. Toegang tot de inkoopgegevens wordt apart toegekend.
  • Voorraad: voorraad per locatie en per inkoopregel, inclusief traceerbaarheid. Met de voorraadmutaties zie je ook hoe die voorraad is ontstaan: ontvangsten, uitgiften, productie, ompakken, verplaatsingen, tellingen en correcties.
  • Verkoopstatistieken: omzet, marge en aantallen opvragen, bijvoorbeeld een top 10 per artikel, artikelgroep, merk, magazijn, relatie, klantcategorie of vertegenwoordiger, of het verloop per dag, week, vier weken, maand, kwartaal of jaar, zowel over de volledige historie (dagelijks bijgewerkt) als de meest recente cijfers (meerdere keren per dag bijgewerkt). Het gaat om dezelfde verkoopcijfers als in Management info en statistieken, nu rechtstreeks via de API op te halen.

Tip: Voor koppelingen die periodiek gegevens ophalen, ondersteunt de API het ophalen van alleen de wijzigingen (en verwijderingen) sinds een bepaald tijdstip (incrementele synchronisatie). Zo hoef je 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. Je beheert je API-sleutels zelf in het portaal.

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

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

  2. Meld je aan met je e-mailadres. Je 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 je sleutel in de header X-Api-Key.

    Care4Fresh API Portal

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

Soorten koppelingen en kanalen

Hoeveel van je gegevens een koppeling ziet, hangt af van het soort koppeling:

  • Jezelf: je eigen API-sleutel heeft volledige toegang tot de administraties waartoe je gemachtigd bent.
  • Een partner: bijvoorbeeld een webshopbouwer die een koppeling voor je verzorgt. Deze toegang kun je beperken tot een kanaal.
  • Een B2B-partij: een ander bedrijf dat met je koppelt om zaken te doen. Deze koppeling is altijd beperkt tot een kanaal.

Een kanaal is een afgebakend deel van je artikelen en relaties, op basis van een bestaande im- en exportbundel. Zo ziet een partner, zoals een webshopbouwer, alleen het assortiment en de klanten die voor die koppeling bedoeld zijn, en blijft een B2B-koppeling beperkt tot bijvoorbeeld één leverancier of één klant. Care4iT stelt dit voor je in.

Abonnement

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

AI-assistent koppelen

AI-assistenten zoals Claude en ChatGPT kunnen de Care4Fresh API namens je gebruiken, zonder dat je 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. Je krijgt een Care4Fresh-aanmeldscherm met een toestemmingsvraag. Meld je aan met je e-mailadres en keur de rechten goed die je de assistent wilt geven.
  3. De assistent kan daarna gegevens en verkoopstatistieken raadplegen en, als je dat toestaat, verkooporders aanmaken.

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