Cardora Public Partner API

Documentație Integrare pentru Sisteme POS, Livrare și Comenzi Online

English Română

Bun venit

Bine ați venit la documentația Cardora Public Partner API. Acest API permite sistemelor externe să se integreze cu platforma programului de loialitate Cardora, permițându-vă să:

🚀 Start Rapid

  1. Obțineți o cheie API din panoul de administrare Cardora
  2. Consultați documentația API pentru autentificare și utilizare
  3. Verificați specificația OpenAPI pentru detalii complete despre endpoint-uri

Fișiere Documentație

Endpoint-uri Disponibile

Metodă Endpoint Descriere
POST /customers/identify-from-card Identificare client din token cod QR card
POST /customers/upsert Creare sau actualizare client cu mapare ID extern
GET /customers/{externalCustomerId} Obținere informații client și solduri carduri după ID extern
GET /card-templates Listare toate șabloanele active de carduri de loialitate pentru afacere

Pentru documentație completă despre endpoint-uri, consultați referința endpoint-uri, documentația API și specificația OpenAPI.

Caracteristici Cheie

✅ Autentificare și Securitate

  • Autentificare cheie API prin header X-API-Key
  • Suport listă de permisiuni IP

✅ Limitare Rate

  • Limite de rate per cheie (implicit: 60 cereri/minut)
  • Configurabil per cheie API
  • Răspunsuri 429 cu header-uri retry-after

✅ Gestionare Erori

  • Răspunsuri JSON consistente pentru erori
  • Coduri de eroare citibile de mașină
  • Coduri de status HTTP adecvate

📚 Documentație

  • Referință API completă în documentația HTML
  • Specificație OpenAPI 3.0 pentru generarea de cod
  • Exemple de cod în Python, JavaScript și PHP

Începerea

1. Obțineți o Cheie API

Conectați-vă la panoul de administrare Cardora și navigați la Setări → Chei API pentru a crea o cheie API nouă.

2. Testați Conexiunea

Folosiți token-ul de test pentru a verifica cheia API fără a procesa date reale:

curl -X POST https://app.cardora.ro/api/public/v1/customers/identify-from-card \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cardInstanceToken": "0_0_000000000_000000000000"}'

Acest token de test returnează date de test hardcodate și nu accesează baza de date.

3. Consultați Documentația

Consultați documentația API pentru exemple detaliate în Python, JavaScript și PHP.

Suport

Pentru întrebări, probleme sau solicitări de funcții, vă rugăm să contactați: