L’API è accessibile creando delle request HTTPS and un determinato endpoint. L’endpoint e’ accessibile esclusivamente attraverso il protocollo sicuro SSL.
Endpoint
https://api.rfmcube.com/v1Le request devono essere inviate su HTTPS ed il contenuto del payload deve essere JSON (application/json). Ogni request deve includere gli header content-type: application/json e api-key che verrà valorizzato con la chiave API del tuo connector.
La chiave API viene generata automaticamente e può essere trovata nelle impostazioni del tuo connector, alla voce Chiave Api.
Informazioni RFM del customer
Descrizione: passando nel payload o l’id o l’email del tuo customer (non è necessario passarli entrambi!) RFMCube ti restituire le informazioni su di esso compresa l’appartenenza ai tuoi segmenti avanzati.
POST: https://api.rfmcube.com/v1/customer_stats
PAYLOAD:
{
"id" : "342",
"email" : "customer@test.com"
}
RESPONSE:
{
"customer" : {
"id" : 999673,
"externalId" : "342",
"email" : "customer@test.com",
"createdAt" : "2015-09-16T17:34:19Z",
"firstTransaction" : "2015-09-16T19:34:00Z",
"lastTransaction" : "2018-10-19T19:45:09Z",
"totalTransactions" : 11,
"total" : 344.06,
"aov" : 31.28,
"rfmScore" : 254,
"longevity" : 1237,
"recency" : 108,
"latency" : 113,
"orders" : [ ]
},
"segments" : [ {
"id" : 1,
"name" : "Adv Segment A"
}, {
"id" : 4,
"name" : "Adv Segment B"
} ]
}
Lista customer per segmento
Descrizione: passando nel payload l’id del segmento avanzato verrà restituita la lista dei customer appartenenti a quel segmento. Vanno inoltre specificati i campi del customer che verranno ritornati, i campi disponibili sono quelli della response di Informazioni RFM del customer.
POST: https://api.rfmcube.com/v1/customers_by_segment
PAYLOAD:
{
"id" : 2,
"fields" : [ "email" , "rfmScore" ]
}
RESPONSE:
[ {
"email" : "customer1@example.rfmcube.com",
"rfmScore" : 312
}, {
"email" : "customer2@example.rfmcube.com",
"rfmScore" : 312
} ]
Lista customer con statistiche aggiornate da quella data in avanti
Descrizione: passando nel payload una data senza ora e senza fuso orario verrà restituita la lista dei customer che hanno l’ultimo aggiornamento delle statistiche uguale o successivo alla data passata nel payload. Vanno inoltre specificati i campi del customer che verranno ritornati, i campi disponibili sono quelli della response di Informazioni RFM del customer.
POST: https://api.rfmcube.com/v1/customers_stats_updated_same_or_after
PAYLOAD:
{
"updateDate" : "2024-04-04",
"fields" : [ "email" , "rfmScore" ]
}
RESPONSE:
[ {
"email" : "customer1@example.rfmcube.com",
"rfmScore" : 312
}, {
"email" : "customer2@example.rfmcube.com",
"rfmScore" : 312
} ]
Statistiche dei segmenti base (funnel)
Descrizione: restituisce le statistiche generali dei segmenti base. Sono i dati che si vedono nei funnel di un connector.
GET: https://api.rfmcube.com/v1/stats/segmentsfunnel
RESPONSE:
{
"total": 6809,
"recency": [{
"name": "+ 365 giorni",
"score": 1,
"value": 5633
}, {
"name": "da 180 a 365 giorni",
"score": 2,
"value": 1047
}, {
"name": "da 180 a 60 giorni",
"score": 3,
"value": 129
}, {
"name": "ultimi 2 mesi",
"score": 4,
"value": 0
}],
"frequency": [{
"name": "1 acquisto",
"score": 1,
"value": 5920
}, {
"name": "2 acquisti",
"score": 2,
"value": 672
}, {
"name": "3+ acquisti",
"score": 3,
"value": 217
}],
"monetary": [{
"name": "<60",
"score": 1,
"value": 18
}, {
"name": "TRA 61 150",
"score": 2,
"value": 362
}, {
"name": "DA 100 A 300",
"score": 3,
"value": 1320
}, {
"name": "DA 301 A 500",
"score": 4,
"value": 1984
}, {
"name": ">501",
"score": 5,
"value": 3125
}]
}
Potrebbero interessarti anche:
