Entwicklerv1

CargaCell API

Das gleiche Backend wie die Webanwendung ist über HTTP verfügbar. Erstellen Sie einen API-Schlüssel in Ihrem Profil und authentifizieren Sie Server-zu-Server-Anfragen mit dem x-api-key-Header.

Basis-URLhttps://www.cargacell.com/api/v1
API-Schlüssel holen →

Schnellstart

API-Schlüssel-Authentifizierung

Senden Sie Ihren Schlüssel im x-api-key-Header bei jeder Anfrage. JWT-Browsersitzungen funktionieren weiterhin parallel für Web-Clients.

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

IP-Whitelist-Verhalten

  • 0Jede IP ist erlaubt — Standard für neue Schlüssel.
  • ≥1Nur diese genauen Adressen werden akzeptiert.
  • WiderrufenDer Schlüssel hört sofort auf zu funktionieren; erstellen Sie einen neuen.

Endpoint-Referenz

Alle Pfade sind relativ zur obigen Basis-URL.

Endpoints mit dem Tag Nur Web erfordern ein Browser-Sitzungstoken und lehnen die x-api-key-Authentifizierung ab.

Authentifizierung

Schlüssel validieren und das aktuelle Kontoprofil lesen oder aktualisieren.

MethodePfadBeschreibungTags
POST/auth/loginAnmeldung mit E-Mail und Passwort
GET/auth/meAktuellen authentifizierten Benutzer abrufen
PATCH/auth/meProfil und Rechnungsdaten aktualisieren

Katalog & Warenkorb

Betreiber und Produkte durchsuchen, dann Bestellungen vor dem Checkout zusammenstellen.

MethodePfadBeschreibungTags
GET/catalog/countriesVerfügbare Länder auflisten
GET/catalog/operatorsVerfügbare Betreiber auflisten
GET/catalog/recharge-productsAuflade-Katalog mit Filtern
GET/cartAktuellen Warenkorb abrufen
POST/cart/itemsArtikel zum Warenkorb hinzufügen
DELETE/cart/items/:itemIdArtikel aus dem Warenkorb entfernen

Zahlungen & Wallet

Preise berechnen und Aufladungen mit Wallet-Guthaben versenden. Externer Checkout ist nur für Web-Sitzungen.

MethodePfadBeschreibungTags
POST/payments/quotePreisangebot einholen
POST/payments/prepareWeb-Checkout-Eingaben validieren
Nur Web
POST/payments/checkoutExternen Web-Checkout abschließen
Nur Web
GET/payments/historyZahlungsverlauf
GET/wallet/balanceAktuelles Wallet-Guthaben
POST/wallet/checkoutWallet-finanzierte Aufladungen versenden
POST/api-access/b2b/rechargesDedizierte B2B-Wallet-Aufladung
B2B

Administration

Admin-Konten können denselben API-Schlüssel-Mechanismus für alle Back-Office-Endpoints verwenden.

MethodePfadBeschreibungTags
GET/admin/summaryDashboard-Zusammenfassung
Admin
GET/admin/usersBenutzerverwaltung
Admin
GET/admin/rechargesAuflade-Operationen
Admin
GET/admin/paymentsZahlungsoperationen
Admin
GET/admin/productsKatalogoperationen
Admin

Code-Beispiele

Live-Beispiele, die das aktuelle Backend-Verhalten widerspiegeln. Wechseln Sie in jeder Karte zwischen Anfrage und Antwort.

Schlüssel überprüfen

Senden Sie eine GET-Anfrage, um die Authentifizierung zu bestätigen und das zugehörige Konto zu inspizieren.

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

Produkte mit Promo-Details auflisten

Rufen Sie den Auflade-Katalog ab. Produkte mit aktiven oder geplanten Promotionen enthalten vollständige Promo-Details (Name, Beschreibung, optionale Bedingungen).

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 zum Warenkorb hinzufügen

Fügen Sie eine Empfängerzeile zum Warenkorb hinzu. Rufen Sie zuerst den Produktkatalog ab, um eine gültige productId zu ermitteln.

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-Wallet-Aufladung

Dedizierter B2B-Endpoint — überspringt MONEI vollständig und versendet sofort aus dem genehmigten Wallet-Guthaben.

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"
  }'

Generischer Wallet-Checkout

Standard-Wallet-finanzierter Checkout — funktioniert mit API-Schlüsseln und Web-Sitzungen.

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"
  }'

Aufladungen auflisten (Admin)

Admin-API-Schlüssel können Back-Office-Endpoints mit demselben x-api-key-Header aufrufen.

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

Auflade-Flows

Es gibt drei Versandwege. Wählen Sie den passenden für Ihre Integration.

1

Externer Zahlungs-Checkout

Nur Web

Der Browser initiiert eine MONEI-Zahlung über POST /payments/prepare, bestätigt dann nach der Autorisierung über POST /payments/checkout. Erfordert eine JWT-Web-Sitzung. API-Schlüssel werden abgelehnt.

2

Wallet-Checkout

Rufen Sie POST /wallet/checkout mit Ihren Artikeln auf. Das Backend berechnet das verfügbare Guthaben aus genehmigten Aufladungen minus erfasster Wallet-Zahlungen und lehnt ab, wenn unzureichend. Funktioniert mit API-Schlüsseln und Web-Sitzungen.

3

B2B-Wallet-Aufladung

B2B

Rufen Sie POST /api-access/b2b/recharges auf. Verwendet dasselbe Wallet-System wie Weg 2, aber ist speziell für API-Schlüssel-Clients konzipiert, die nie mit dem MONEI-Flow interagieren müssen. Versendet sofort, wenn das Guthaben ausreicht.

In allen wallet-finanzierten Wegen erstellt eine erfolgreiche Zahlung Auflade-Warteschlangen-Zeilen. Diese werden vom Auflade-Prozessor versandt oder als wartend markiert, wenn ein DT-One-Promotionsfenster gilt.

Schlüsselverwaltung

Alle Schlüsseloperationen sind in Dashboard → Profil verfügbar.

1

Erstellen

Erstellen Sie einen benannten Schlüssel für jede Integration oder Umgebung. Der Klartext-Wert wird nur einmal bei der Erstellung angezeigt — kopieren Sie ihn sofort.

2

Einschränken

Fügen Sie IP-Whitelist-Einträge hinzu, um einen Schlüssel auf feste Infrastruktur zu sperren — Büro-Gateways, Worker-Server oder Cloud-Funktions-Ausgangs-IPs.

3

Widerrufen

Widerrufen Sie kompromittierte oder ungenutzte Schlüssel sofort. Der Widerruf tritt augenblicklich in Kraft. Verwenden Sie alte Schlüssel niemals wieder — generieren Sie stattdessen einen neuen.