Ontwikkelaarv1

CargaCell API

Dezelfde backend als de webapplicatie is beschikbaar via HTTP. Maak een API-sleutel aan in uw profiel en authenticeer server-naar-server-verzoeken met de x-api-key-header.

Basis-URLhttps://www.cargacell.com/api/v1
API-sleutel ophalen →

Snel starten

API-sleutelauthenticatie

Stuur uw sleutel in de x-api-key-header bij elk verzoek. JWT-browsersessies blijven parallel werken voor webclients.

curl -X GET \
  https://www.cargacell.com/api/v1/auth/me \
  -H "x-api-key: cc_live_your_key"

IP-whitelist-gedrag

  • 0Elk IP is toegestaan — standaard voor nieuwe sleutels.
  • ≥1Alleen die exacte adressen worden geaccepteerd.
  • IntrekkenDe sleutel stopt onmiddellijk met werken; maak een nieuwe aan.

Endpoint-referentie

Alle paden zijn relatief aan de bovenstaande basis-URL.

Endpoints gemarkeerd als Alleen web vereisen een browsersessietoken en weigeren x-api-key-authenticatie.

Authenticatie

Valideer de sleutel en lees of update het huidige accountprofiel.

MethodePadBeschrijvingTags
POST/auth/loginAanmelden met e-mail en wachtwoord
GET/auth/meHuidige geauthenticeerde gebruiker ophalen
PATCH/auth/meProfiel en facturatiegegevens bijwerken

Catalogus & winkelwagen

Blader door operators en producten, stel daarna bestellingen samen voor betaling.

MethodePadBeschrijvingTags
GET/catalog/countriesBeschikbare landen weergeven
GET/catalog/operatorsBeschikbare operators weergeven
GET/catalog/recharge-productsOpwaardeer-catalogus met filters
GET/cartHuidige winkelwagen ophalen
POST/cart/itemsArtikel toevoegen aan winkelwagen
DELETE/cart/items/:itemIdArtikel verwijderen uit winkelwagen

Betalingen & portemonnee

Bereken prijzen en verstuur opwaarderingen met portemonnee-saldo. Externe checkout is alleen voor websessies.

MethodePadBeschrijvingTags
POST/payments/quotePrijsofferte opvragen
POST/payments/prepareWebcheckout-invoer valideren
Alleen web
POST/payments/checkoutExterne webcheckout afronden
Alleen web
GET/payments/historyBetalingsgeschiedenis
GET/wallet/balanceHuidig portemonnee-saldo
POST/wallet/checkoutPortemonnee-gefinancierde opwaarderingen versturen
POST/api-access/b2b/rechargesToegewijde B2B-portemonnee-opwaardering
B2B

Beheer

Beheerdersaccounts kunnen hetzelfde API-sleutelmechanisme gebruiken voor alle back-office-endpoints.

MethodePadBeschrijvingTags
GET/admin/summaryDashboard-samenvatting
Admin
GET/admin/usersGebruikersbeheer
Admin
GET/admin/rechargesOpwaardeeroperaties
Admin
GET/admin/paymentsBetalingsoperaties
Admin
GET/admin/productsCatalogusoperaties
Admin

Codevoorbeelden

Live voorbeelden die het huidige backendgedrag weerspiegelen. Wissel tussen Verzoek en Reactie in elke kaart.

Uw sleutel verifiëren

Stuur een GET-verzoek om te bevestigen dat authenticatie werkt en het bijbehorende account te inspecteren.

curl -X GET \
  https://www.cargacell.com/api/v1/auth/me \
  -H "x-api-key: cc_live_your_generated_key" \
  -H "Accept-Language: en"

Producten weergeven met promotiedetails

Haal de opwaardeer-catalogus op. Producten met actieve of geplande promoties bevatten volledige promo-details (naam, beschrijving, optionele voorwaarden).

curl -X GET \
  "https://www.cargacell.com/api/v1/catalog/recharge-products?country=ES&limit=5" \
  -H "x-api-key: cc_live_your_generated_key" \
  -H "Accept-Language: en"

Artikel toevoegen aan winkelwagen

Voeg een ontvangersregel toe aan de winkelwagen. Haal eerst de productcatalogus op om een geldig productId te vinden.

curl -X POST \
  https://www.cargacell.com/api/v1/cart/items \
  -H "Content-Type: application/json" \
  -H "x-api-key: cc_live_your_generated_key" \
  -d '{
    "sessionId": "agent-session-001",
    "productId": "12345",
    "recipientNumber": "+5355512345",
    "quantity": 2
  }'

B2B-portemonnee-opwaardering

Toegewijd B2B-endpoint — slaat MONEI volledig over en verstuurt onmiddellijk vanuit het goedgekeurde portemonnee-saldo.

curl -X POST \
  https://www.cargacell.com/api/v1/api-access/b2b/recharges \
  -H "Content-Type: application/json" \
  -H "x-api-key: cc_live_your_generated_key" \
  -d '{
    "items": [
      {
        "productId": "12345",
        "recipientNumber": "+5355512345",
        "quantity": 2
      }
    ],
    "baseCurrency": "EUR"
  }'

Generieke portemonnee-checkout

Standaard portemonnee-gefinancierde checkout — werkt met API-sleutels en websessies.

curl -X POST \
  https://www.cargacell.com/api/v1/wallet/checkout \
  -H "Content-Type: application/json" \
  -H "x-api-key: cc_live_your_generated_key" \
  -d '{
    "items": [
      {
        "productId": "12345",
        "recipientNumber": "+5355512345",
        "quantity": 1
      }
    ],
    "baseCurrency": "EUR"
  }'

Opwaarderingen weergeven (beheerder)

Beheerder-API-sleutels kunnen back-office-endpoints aanroepen met dezelfde x-api-key-header.

curl -X GET \
  "https://www.cargacell.com/api/v1/admin/recharges?page=1&limit=20" \
  -H "x-api-key: cc_live_admin_key"

Opwaardeerstromen

Er zijn drie verzendpaden. Kies het pad dat past bij uw integratie.

1

Externe betalingscheckout

Alleen web

De browser initieert een MONEI-betaling via POST /payments/prepare, bevestigt daarna na autorisatie via POST /payments/checkout. Vereist een JWT-websessie. API-sleutels worden geweigerd.

2

Portemonnee-checkout

Roep POST /wallet/checkout aan met uw artikelen. De backend berekent het beschikbare saldo uit goedgekeurde opwaarderingen minus vastgelegde portemonnee-betalingen en weigert als het onvoldoende is. Werkt met API-sleutels en websessies.

3

B2B-portemonnee-opwaardering

B2B

Roep POST /api-access/b2b/recharges aan. Gebruikt dezelfde portemonnee-engine als pad 2, maar is speciaal gebouwd voor API-sleutelclients die nooit mogen interacteren met de MONEI-stroom. Verstuurt onmiddellijk als het saldo voldoende is.

In alle portemonnee-gefinancierde paden creëert een geslaagde betaling rijen in de opwaardeerwachtrij. Deze worden verwerkt door de opwaardeerprocessor, of als wachtend gemarkeerd wanneer een DT One-promotievenster van toepassing is.

Sleutelbeheer

Alle sleuteloperaties zijn beschikbaar in Dashboard → Profiel.

1

Aanmaken

Maak een benoemde sleutel aan voor elke integratie of omgeving. De platte tekst-waarde wordt slechts eenmaal weergegeven bij aanmaak — kopieer deze onmiddellijk.

2

Beperken

Voeg IP-whitelist-vermeldingen toe om een sleutel te vergrendelen op vaste infrastructuur — kantoorgateway, workerservers of cloud-functie-uitgangs-IP's.

3

Intrekken

Trek gecompromitteerde of ongebruikte sleutels onmiddellijk in. Intrekking heeft onmiddellijk effect. Gebruik oude sleutels nooit opnieuw — genereer in plaats daarvan een nieuwe.