IndaBox API Integration
Scarica la documentazione completa in PDF.
Documentazione-api-IndaBox-v1.2Domande Frequenti
-
Domande generiche
Quali sono i primi passi da seguire?
- 1. Registrati su indabox.it.
- 2. Chiedi l’upgrade del tuo account utente ad account “Merchant”, da questa pagina. Ti avviseremo una volta effettuato l'upgrade.
- 3. A questo punto otterrai l’API Key ed il merchant ID, due parametri necessari per usare IndaBox ed implementare le nostre API. Trovi questi dati effettuando il login su indabox.it con il tuo account Merchant.
- 4. Se non l'hai ancora fatto, scarica la documentazione delle API e procedi con l'implementazione nell'ambiente SANDBOX (ambiente di test).
Ci sono dei limiti di dimensione, peso o valore degli oggetti spediti?I punti di ritiro IndaBox accettano merce di peso non superiore a 20kg e di volume non superiore a 0,2 metri cubi. Nel caso dovesse pervenire merce di dimensione o peso superiore a quelle indicate, la consegna verrà rifiutata. Inoltre non è possibile inviare presso IndaBox point oggetti di valore superiore a 500€. E’ quindi importante, nello scrivere l’applicazione di integrazione, tenere a mente questi vincoli.Come compilo il mio “profilo” su IndaBox.it?Username: a scelta, non modificabile;
email: è l'email alla quale verranno inviate le notifiche provenienti dalle API;
Nome, Cognome, Indirizzo, CAP, Comune, Città, P.iva, Ragione sociale: indicare i dati anagrafici dell’attività; i dati verranno utilizzati per la futura fatturazione degli eventuali crediti acquistati.Il sistema IndaBox invia delle notifiche?Sì. Ecco cosa succede quando un utente sceglie IndaBox come metodo di consegna, una volta effettuata con successo l’integrazione delle API, in particolare la chiamata “segnala spedizione”.
1. Il punto di ritiro scelto viene avvertito, tramite email ed SMS, una volta che la vostra applicazione chiamerà la funzione “segnala spedizione” (submitOrder, vedi documentazione).
2. Una volta che il corriere consegna la tua merce, invieremo a te (via email) ed al tuo cliente (via email ed SMS, se fornito), la notifica della disponibilità della merce.
Puoi consultare in qualsiasi momento lo status delle tue spedizioni sui punti di ritiro IndaBox, accedendo al sito indabox.it con il tuo account Merchant, oppure tramite specifica chiamata API.
Ti invieremo, inoltre, una email di notifica quando il tuo saldo crediti sarà inferiore a 4, per avvertirti dell'imminente disattivazione (automatica) del servizio.E’ previsto un periodo di testing prima di andare in produzione?Sì, subito dopo che avremo creato il tuo account “Merchant” imposteremo il tuo account in modalità “sandbox”. In questa modalità non ci saranno impatti sul server di produzione IndaBox e potrai consultare l’esito delle chiamate effettuate direttamente accedendo ad indabox.it col il tuo account merchant.Cos'è l'indice di affidabilità del punto di ritiro?L'indice di affidabilità è un valore che va da 0 a 100, con il quale si esplicita l'affidabilità del punto di ritiro nel ricevere e gestire il servizio IndaBox. Valori superiori a 60 indicano un punto di ritiro preparato ed affidabile, valori inferiori possono indicare che il punto di ritiro non riceve o gestisce consegne da alcuni giorni. E' facoltà dell'e-seller scegliere quali punti di ritiro offrire sul proprio sito, sulla base dell'indice di affidabilità. L'indice viene aggiornato 12 volte al giorno, e varia in base alle attività dei relativi punti di ritiro (spedizioni gestite, "manutenzione diretta" IndaBox del punto di ritiro, chiusure, ecc.).Chiusura dei punti di ritiroLe API IndaBox restituiscono un elenco dei punti di ritiro che non hanno segnalato giorni di chiusura al momento della chiamata, e che sono quindi disponibili a ricevere spedizioni. Il criterio di disponibilità del punto di ritiro è: "non disponibile" da 3gg prima della data di inizio periodo chiusura (in modo da evitare segnalazioni pochi giorni prima dei giorni di chiusura previsti) "disponibile" da 1gg prima della data di riapertura (in modo da dare la possibilità di segnalare spedizioni che potrebbero essere già in consegna il giorno successivo, in cui il punto di ritiro sarà aperto). -
Contratto e costi
Quanto costa il servizio IndaBox?Il servizio IndaBox ha un costo per ogni spedizione che farai pervenire ad un punto di ritiro. La tariffa varia in base agli specifici accordi. Puoi scegliere di "ribaltare" il costo del servizio sul tuo cliente finale, dandogli la possibilità di scegliere l'opzione di consegna "Corriere + IndaBox" incrementando le tue spese di spedizione standard, oppure puoi decidere di offrire il nostro servizio gratis ai tuoi clienti.
Ogni volta che un tuo cliente sceglierà di spedire qualcosa in un punto di ritiro IndaBox, ti verrà scalato 1 credito. Quando il tuo saldo crediti, consultabile su indabox.it, si esaurisce, il servizio viene sospeso. Se sei soddisfatto del nostro servizio, potrai acquistare nuovi crediti collegandoti con il tuo account Merchant a questa pagina. Scopri cosa sono i crediti spedizione.Si può provare gratuitamente il servizio?Sì, dopo che avrai richiesto l'account merchant, ti accrediteremo subito e gratuitamente 20 “Crediti Spedizione IndaBox” necessari per poter usufruire del servizio.Gli utenti del mio sito e-commerce devono accettare le condizioni IndaBox?Sì: è importante che l’utente del sito di vendita online sul quale viene integrato il servizio IndaBox, accetti esplicitamente anche i termini e le condizioni IndaBox (oltre a quelle generali del vostro sito). E’ quindi necessario che, in fase di scelta del metodo di spedizione IndaBox, venga proposta all’utente una checkbox di controllo con la quale vengano esplicitamente accettate le condizioni e l’informativa presenti a questo indirizzo http://www.indabox.it/condizioni-api/. E’ consigliabile illustrare le condizioni direttamente in pagina tramite iframe.Devo firmare un contratto con IndaBox per integrare il servizio?Sì, una volta finiti i test in ambiente sandbox, prima di portare il servizio in produzione, occorrerà stampare, firmare ed inviare all’indirizzo merchant@indabox.it il contratto presente in questa pagina http://www.indabox.it/termini-eco/. -
Implementazione
Dove scarico la documentazione delle API IndaBox?
Scarica la documentazione completa in PDF.
Documentazione-api-IndaBox-v1.0Qual è la versione corrente delle API?La versione corrente è la 1.0. Dovrai quindi impostare le tue chiamate su queste url:
- Ambiente sandbox, per test: https://www.indabox.it/sandbox/v1.0/
- Ambiente produzione: https://www.indabox.it/api/v1.0/
Quali sono le principali funzioni delle API?Le due principali chiamate sono:
getPoints --> tramite questa chiamata è possibile ottenere, dato un indirizzo ed un raggio di ricerca, un elenco di punti di ritiro IndaBox
submitOrder --> tramite questa chiamata, è possibile "segnalare una spedizione" presso un punto di ritiro IndaBox.Che risultati ottengo dalla chiamata getPoints?Ecco un esempio:
{
"pointid":"2597", // id del punto di ritiro
"name":"Gastronomia Da Alice", // nome del punto di ritiro
"toponimo":"Via", // via, strada, corso, piazza...
"indirizzo":"Buschetti", // nome della via
"civico":"13", // numero civico
"cap":"10023", // cap
"comune":"Chieri", // comune
"localita":"", // indica, se presente, la frazione del comune
"provincia":"TO", // provincia
"presso_note":"", // presso o note relative all'indirizzo
"tel":"0112630861", // numero di telefono
"lat":"45.014352", // latitudine
"lng":"7.8142780000000585", // longitudine
"orari":"Lun -> Sab: 08:00 - 19:30\r\n\r\nDom: chiuso", // orari (campo non strutturato)
"uri":"http:\/\/www.indabox.it\/punti_ritiro\/gastronomia-da-alice", // url sito
"indice":"96", // indice di manutenzione del punto di ritiro (0-100)
"distance":"6.09", // distanza dall'indirizzo cercato
"id_categoria":"15", // id della categoria del punto di ritiro
"categoria":"altro" // nome della categoria del punto di ritiro
},
{
(...)
}
