Sviluppatori - API ZEROSIX

In questo spazio trovi tutto ciò che ti serve per realizzare facilmente il tuo progetto per integrare le funzionalità di Zerosix nella tua applicazione, sito o software. Cosa trovare qui?: esempi di codice, guide all'integrazione e documentazione dettagliata.

Guía de introducción para la API zerosix

Guida Introduttiva

È qui il punto di partenza, anche se hai fretta ;)

Iniziamo!
Referencia de API

Riferimento API

Documentazione API dettagliata ed esempi in più lingue.

Consulta la documentazione

Guida Introduttiva

Le API Zerosix Rest ti consentiranno di integrare facilmente le nostre funzionalità nei tuoi sistemi, che si tratti di un software per registratori di cassa, software commerciali, un sito e-commerce o un'app mobile.

Le funzionalità esposte nell'API sono funzionalità operative. La configurazione del servizio in quanto tale avviene tramite la dashboard o tramite il loyalty coach di Zerosix.

L'utenticazione delle chiamate verrà eseguita in modo abbastanza standard utilizzando una chiave API. Se sei già cliente Zerosix, troverai la tua chiave API disponibile nel tuo pannello di controllo; altrimenti, contattaci per creare un account di prova.

Inizia con le nostre API

Rivediamo insieme le poche chiamate fondamentali per creare una carta fedeltà e registrare ogni movimento.

Creare una Carta Fedeltà

Curl
Python
Php
+ Vedere più codici
Contact create
Curl --request POST \--url "https://api.zerosix.com/contacts/"--header 'Authorization: Token YOUR-API-KEY' \--header 'Content-Type: application/json' \--data '{"mobile" : 0700000003 ,"first_name" : John ,"last_name" : Doe ,"create_card" : true}'

Response \
{"url": "https://api.zerosix.com/cards/{{card_id}}/","mobile": "MOBILE","first_name": "John","last_name": "Doe","birth_date": null,"gender": null,"address1": null,"address2": null,"zipcode": null,"city": null,"country": "France","email": null,"opt_out": false,"allow_email": false,"allow_pdf": false,"card": {"url": "https://api.zerosix.com/cards/{{card_id}}/","reference": "{{card_id}}","points_balance": 0},"available_vouchers" : [],"dashboard_url" : "DASHBOARD_URL","custom_fields" : []}
import requests
payload = "{"mobile": "0700000003","first_name": "John","last_name": "Doe","create_card": "true"}",headers = { 'Authorization' : Token YOUR-API-KEY ,'Content-Type' : application/json}
response = requests.request("POST" url, data=payload, headers=headers)print(reponse.text)

Response \
{"url": "https://api.zerosix.com/cards/{{card_id}}/","mobile": "MOBILE","first_name": "John","last_name": "Doe","birth_date": null,"gender": null,"address1": null,"address2": null,"zipcode": null,"city": null,"country": "France","email": null,"opt_out": false,"allow_email": false,"allow_pdf": false,"card": {"url": "https://api.zerosix.com/cards/{{card_id}}/","reference": "{{card_id}}","points_balance": 0},"available_vouchers" : [],"dashboard_url" : "DASHBOARD_URL","custom_fields" : []}
<?php
$curl = curl_init();
curl_setopt_array($curl, array(CURLOPT_URL =>"https://api.zerosix.com/contacts/",CURLOPT_RETURNTRANSFER =>true,CURLOPT_ENCODING =>"",CURLOPT_MAXREDIRS =>10,CURLOPT_TIMEOUT =>30,CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,CURLOPT_CUSTOMREQUEST =>"POST",CURLOPT_POSTFIELDS =>"{"mobile": "0700000003","first_name": "John","last_name": "Doe","create_card": "true"}",CURLOPT_HTTPHEADER =>array("Authorization: Token YOUR-API-KEY","Content-Type: application/json"),));
$response = curl_exec($curl);$err = curl_error($curl);
if ($err) {echo "cURL Error #:" . $err;}else {echo $response;}

Response \
{"url": "https://api.zerosix.com/cards/{{card_id}}/","mobile": "MOBILE","first_name": "John","last_name": "Doe","birth_date": null,"gender": null,"address1": null,"address2": null,"zipcode": null,"city": null,"country": "France","email": null,"opt_out": false,"allow_email": false,"allow_pdf": false,"card": {"url": "https://api.zerosix.com/cards/{{card_id}}/","reference": "{{card_id}}","points_balance": 0},"available_vouchers" : [],"dashboard_url" : "DASHBOARD_URL","custom_fields" : []}

Creazione di una visita

Curl
Python
Php
+ Vedere più codici
Contact create
Curl --request POST \--url "https://api.zerosix.com/visits/"--header 'Authorization: Token YOUR-API-KEY' \--header 'Content-Type: application/json' \--data '{"card" : "http://api.zerosix.com/cards/{{card_id}}/" ,"price" : "23.50"}'

Response \
{"url": "https://api.zerosix.com/visits/{{visit_id}}/","card": {"url": "https://api.zerosix.com/cards/{{card_id}}/","reference": "{{card_id}}","points_balance": 93,"points_balance": null},"date" : "2017-10-07T08:34:58Z","price" : "23.50","details" : null,"comment" : null,"used_vouchers" : [],"cashback_withdraw_value" : null,"message" : "Merci pour votre fidélité. Nouveau solde : 93"}
import requests
"url": "https://api.zerosix.com/visits/"
payload = "{"card": "http://api.zerosix.com/cards/{{card_id}}","price": "23.50"}",headers = { 'Authorization' : Token YOUR-API-KEY ,'Content-Type' : application/json}
response = requests.request("POST" url, data=payload, headers=headers)print(reponse.text)

Response \
{"url": "https://api.zerosix.com/visits/{{visit_id}}/","card": {"url": "https://api.zerosix.com/cards/{{card_id}}/","reference": "{{card_id}}","points_balance": 93,"points_balance": null},"date" : "2017-10-07T08:34:58Z","price" : "23.50","details" : null,"comment" : null,"used_vouchers" : [],"cashback_withdraw_value" : null,"message" : "Merci pour votre fidélité. Nouveau solde : 93"}
<?php
$curl = curl_init();
curl_setopt_array($curl, array(CURLOPT_URL =>"https://api.zerosix.com/visits/",CURLOPT_RETURNTRANSFER =>true,CURLOPT_ENCODING =>"",CURLOPT_MAXREDIRS =>10,CURLOPT_TIMEOUT =>30,CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,CURLOPT_CUSTOMREQUEST =>"POST",CURLOPT_POSTFIELDS =>"{"card": "http://api.zerosix.com/cards/{{card_id}}","price": "23.50",}",CURLOPT_HTTPHEADER =>array("Authorization": "Token YOUR-API-KEY""Content-Type: application/json"),));
$response = curl_exec($curl);$err = curl_error($curl);
curl_close($curl);
if ($err) {echo "cURL Error #:" . $err;}else {echo $response;}

Response \
{"url": "https://api.zerosix.com/visits/{{visit_id}}/","card": {"url": "https://api.zerosix.com/cards/{{card_id}}/","reference": "{{card_id}}","points_balance": 93,"points_balance": null},"date" : "2017-10-07T08:34:58Z","price" : "23.50","details" : null,"comment" : null,"used_vouchers" : [],"cashback_withdraw_value" : null,"message" : "Merci pour votre fidélité. Nouveau solde : 93"}

Per andare oltre: Postman

Se non conosci Postman, preparati a consocerlo. Usiamo Postman non solo come strumento di sviluppo quotidiano, ma anche come soluzione di documentazione interattiva. È un vantaggio significativo poterti offrire il download di una raccolta di tutti i endpoint scaricabili sulla tua macchina con un solo clic..

Dovrai solo inserire la tua chiave API in una variabile del suo intorno e potrai iniziare a giocare dal vivo con tutti i nostri endpoint.

Passaggio 1

Crea un account Postman se necessario e installa l'applicazione desktop : https://www.getpostman.com/

Passaggio 2

Clicca sul pulsante "Apri in Postman" sopra.

Paso 3

In Postman, a sinistra, nel menu Collections appare la Collection API di Zerosix.

Passaggio 4

In alto a destra, cerca Manage Environment Crea un environment con le due chiavi url e token come in screenshot. Sostituisci YOUR-API-KEY con la tua chiave personale.

Cosa troverai nelle API?

Risorsa
Descrizione

Contact

Il contatto è il titolare della carta. Le informazioni personali sono allegate a questo oggetto.

Card

La carta è collegata a un contatto. È sulla carta che verranno archiviate tutte le informazioni relative al programma e all'attività dell'utente (movimenti, punti, coupon, ecc.).

Visit

Una visita rappresenta il fatto che un titolare di carta è venuto in negozio (o ha effettuato un acquisto online). Ha un timestamp e contiene tutte le informazioni relative a questa interazione (il valore speso, eventuali dettagli di quanto speso, se un coupon è stato utilizzato o meno, ecc.).

Coupon

Un coupon è un codice promozione, un premio, un buono sconto... parole diverse per definire un vantaggio a cui ha diritto un beneficiario quando ne è titolare.

Store

Questo oggetto contiene informazioni sulla struttura o sulle strutture interessate dal programma fedeltà.

OTP

Utilizzato per effettuare una richiesta di invio OTP e verificare una voce OTP. Ciò è particolarmente utile per i siti o le applicazioni di e-commerce che richiedono la verifica dell'identità del titolare della carta prima di allegare una carta all'account di un utente.