Benvenuto!

Questa documentazione web consente ai Partner Infodrive di interfacciare i propri sistemi con i Servizi Infodrive. Tutte le chiamate dettagliate in questa documentazione web sono protette da Autenticazione OAuth 2.0. Se non sei in possesso delle credenziali necessarie all'utilizzo di queste API, contatta l'Assistenza Tecnica inviando una mail a informatica@infodrive.it.

Utilizza il menu di navigazione per spostarti tra le varie sezioni della documentazione web.

1 Introduzione

1.1 Sistema di Autenticazione e Credenziali

Per accedere ai Servizi API Infodrive è necessario effettuare l'autenticazione prima di ogni chiamata. Il sistema di autenticazione utilizzato è il OAuth 2.0 .

A seguito dell'attivazione dei servizi a voi dedicati vi verranno fornite delle Credenziali di Autenticazione API (Client Credentials) composte come di seguito:

  • Client ID
  • Client Secret

Queste credenziali sono necessarie alla generazione del Token di Autenticazione (Bearer Token) da impostare negli header di ogni chiamata da effettuare.

La distinzione tra ambiente di produzione ed ambiente di test è dato dal set di Client Credentials utilizzate per richiedere il Token di Autenticazione.

1.2 Richiesta Token

Consente di richiedere un token. Il token è valido per 60 secondi dalla generazione, scaduti i quali andrà rigenerato con una nuova richiesta. In caso di successo la risposta include anche id_utente, corrispondente all'utente Infodrive associato alle Client Credentials.

POST
https://servizi.infodrive.it/oauth/request/

2 Generiche

2.1 Listini Prodotti e Servizi

Elenco di tutti i prodotti presenti a listino, con relativi prezzi. Le card hanno type: "card". I SAT hanno type: "sat" e cod = valore da passare a sat.Insert.type (aa_sat_modello.id / aa_sat_type_fu.FK_product_model). Non usare i cod card GPS (555/556/731) come type SAT.

POST
https://api.infodrive.it/products/List/
2.2 Listini Servizi Abbinati

Elenco di tutti i servizi abbinabili alla Card principale, presenti a listino.

POST
https://api.infodrive.it/products/ListAbb/

Modalità di Attivazione

Il webservice consente l'attivazione di prodotti e servizi in due modalità differenti. Scegli la modalità di attivazione che più si adatta alle tue esigenze.

Fatturazione a Cliente Finale

Sezione 4

Continua
Fatturazione a Rivenditore

Sezione 5

Continua

4 Fatturazione a Cliente Finale

Questa modalità prevede l'attivazione dei prodotti e servizi generando in contemporanea una fattura al Cliente Finale.

4.1 Attivazione

Consente la creazione di un ordine con uno o più servizi/prodotti Infodrive.

POST
https://api.infodrive.it/invoice/Insert/
  • La visualizzazione dei PDF è disponibile solo in modalità di produzione.
  • L'oggetto
    sat
    è disponibile solo in modalità di produzione

4.2 Variazione Ordine

4.2.1 Aggiunta di uno o più prodotti all'ordine

Consente l'aggiunta di uno o più prodotti all'ordine.

POST
https://api.infodrive.it/invoice/{OrderID}/Edit/AddProducts/
  • La visualizzazione dei PDF è disponibile solo in modalità di produzione.
  • L'oggetto
    sat
    è disponibile solo in modalità di produzione
4.2.2 Eliminazione di uno o più prodotti dall'ordine

Consente l'eliminazione di uno o più prodotti dall'ordine.

POST
https://api.infodrive.it/invoice/{OrderID}/Edit/DeleteProducts/
  • La visualizzazione dei PDF è disponibile solo in modalità di produzione.
  • L'oggetto
    sat
    è disponibile solo in modalità di produzione
4.2.3 Modifica importo della fattura

Consente la modifica dell'importo della fattura.

POST
https://api.infodrive.it/invoice/{OrderID}/Edit/Amount/

La visualizzazione dei PDF è disponibile solo in modalità di produzione.

4.2.4 Modifica Cliente

Consente la modifica dei dati anagrafici del cliente.

POST
https://api.infodrive.it/invoice/{OrderID}/Edit/Customer/

La visualizzazione dei PDF è disponibile solo in modalità di produzione.

4.2.5 Modifica Veicolo

Consente la modifica dei dati del veicolo.

POST
https://api.infodrive.it/invoice/{OrderID}/Edit/Vehicle/

La visualizzazione dei PDF è disponibile solo in modalità di produzione.

4.3 Eliminazione Ordine

Elimina un ordine con tutti i servizi inclusi.

POST
https://api.infodrive.it/invoice/{OrderID}/Delete/
  • Se la relativa fattura è stata già emessa, della stessa verrà fatta nota credito.
  • Non è possibile effettuare eliminazione di ordini decorsi 5 giorni dall'inserimento degli stessi o nel caso in cui si siano verificati già dei sinistri sui servizi di assistenza legati all'ordine.
4.4 Elenco Ordini

Elenco di tutti gli ordini presenti a sistema.

POST
https://api.infodrive.it/invoice/List/
4.5 Dettaglio Ordine

Restituisce i servizi dettagliati contenuti in un ordine.

POST
https://api.infodrive.it/invoice/{OrderID}/Detail/

La visualizzazione dei PDF è disponibile solo in modalità di produzione.

5 Attivazione 2.0

Questa modalità prevede l'attivazione dei prodotti e servizi. Sarà possibile scegliere se emettere fattura servizi al rivenditore o al cliente finale.
N.B: Nel caso nella stessa chiamata vogliate attivare più prodotti contemporaneamente allo stesso cliente, basterà passare un array composto da più JSON richiesta

5.1 Attivazione

Consente la creazione di un ordine con uno o più servizi/prodotti Infodrive.

POST
https://api.infodrive.it/contract/Activate/
  • La visualizzazione dei PDF è disponibile solo in modalità di produzione.
  • L'oggetto
    sat
    è disponibile solo in modalità di produzione
5.2.1 Modifica prezzo rivendita

Consente la modifica del prezzo di rivendita a Cliente finale presente sul modulo di attivazione.

POST
https://api.infodrive.it/contract/{ContractID}/Edit/Amount/

La visualizzazione dei PDF è disponibile solo in modalità di produzione.

5.2.2 Modifica Cliente

Consente la modifica dei dati anagrafici del cliente.

POST
https://api.infodrive.it/contract/{ContractID}/Edit/Customer/

La visualizzazione dei PDF è disponibile solo in modalità di produzione.

5.2.3 Modifica Veicolo

Consente la modifica dei dati del veicolo.

POST
https://api.infodrive.it/contract/{ContractID}/Edit/Vehicle/

La visualizzazione dei PDF è disponibile solo in modalità di produzione.

5.3 Eliminazione Contratto Servizi

Elimina un contratto servizi.

POST
https://api.infodrive.it/contract/Delete/
  • Non è possibile effettuare eliminazione di contratti decorsi 5 giorni dall'inserimento degli stessi o nel caso in cui si siano verificati già dei sinistri sui servizi di assistenza.
5.4 Elenco Contratti

Elenco di tutti i contratti presenti a sistema.

POST
https://api.infodrive.it/contract/Directory/
5.5 Ricerca

Restituisce i contratti attivati ricercando per targa, numero di contratto, dati del cliente. La ricerca verrà effettuata verificando la presenza di tutti i parametri presenti in contemporanea (condizione "and") e non in esclusiva (condizione "or")

POST
https://api.infodrive.it/contract/Search/

La visualizzazione dei PDF è disponibile solo in modalità di produzione.

6 Attivazione Sotto Utenza

Questa modalità prevede l'attivazione delle sotto utenze.

6.1 Attivazione

Consente la creazione di una sottoutenza

POST
https://api.infodrive.it/user/Add/
6.2 Elenco Sotto Utenze

Elenco di tutte le sottoutenze presenti a sistema.

POST
https://api.infodrive.it/user/List/
6.3 Disponibilità marchiature/sat
POST
https://api.infodrive.it/user/getStore/
6.4 Verifica disponibilità marchiatura

Verifica se una marchiatura dello store di un utente è libera (non ancora utilizzata) o occupata (già associata a una tessera). Endpoint complementare a getStore, che restituisce l'elenco delle marchiature disponibili.

POST
https://api.infodrive.it/user/checkMarchiatura/

Il prefisso/suffisso ID nel numero marchiatura viene ignorato in normalizzazione (es. ID12345ID → 12345). È obbligatorio almeno uno tra marchiatura e numero_marchiatura.

7 App Personalizzate

Endpoint per piattaforme esterne: elenco personalizzazioni, verifica email e registrazione di un account app già verificato, con veicolo e fidelizzazione.

7.1 Elenco personalizzazioni

Restituisce le personalizzazioni app associate ai rivenditori della piattaforma (agente = id_venditore_piattaforma), per l'app Infodrive (id_app = 1). Usare id_personalizzazione nella chiamata di registrazione account.

POST
https://api.infodrive.it/app/getList/
7.10 Elenco notifiche e stato lettura (ListNotifications)

Storico notifiche su account_app_notifiche con flag notifica_letta / data_lettura (stesso pannello "Notifiche Inviate" Siris). La conferma lettura è impostata dall'app all'apertura della notifica: non esiste oggi un webhook OneSignal inbound; usare polling su questo endpoint o su 7.11.

POST
https://api.infodrive.it/app/ListNotifications/
7.11 Stato lettura notifica (GetNotificationStatus)

Interroga lo stato di una o più notifiche tramite id_notifica restituito da SendPushNotification. Usare in polling dopo l'invio.

POST
https://api.infodrive.it/app/GetNotificationStatus/

Non è un webhook OneSignal: lo stato letta arriva quando l'utente apre la notifica in app (flag notifica_letta).

7.2 Registrazione account app verificato

Crea un account app già verificato (account_app_global.verificato = si), con fidelizzazione alla personalizzazione indicata e veicolo associato con servizio verificato. La password è generata automaticamente dal sistema e restituita in chiaro nella risposta.

POST
https://api.infodrive.it/app/RegisterVerifiedAccount/
  • id_personalizzazione si ottiene dalla chiamata 7.1 getList.
  • Se l'email è già presente in account_app_global, la chiamata restituisce errore 409.
  • Conservare la password restituita: non è recuperabile in chiaro dopo la creazione.
7.3 Verifica esistenza account

Verifica se esiste già un account in account_app_global per l'email indicata. Utile prima di chiamare 7.2 RegisterVerifiedAccount.

POST
https://api.infodrive.it/app/CheckAccount/
  • La risposta è sempre http_code 200 se l'email è valida: usare il flag exists.
  • Accettato anche anagrafica.email come alternativa a email in root.
7.4 Invio notifica push all'account app

Invia una notifica push OneSignal a uno o più account app. Il target tipico è l'email dell'account (come in Gestione Account Siris / app custom). Il sistema risolve i device registrati in account_app_onesignal, scrive lo storico in account_app_notifiche e inoltra la push a OneSignal.

POST
https://api.infodrive.it/app/SendPushNotification/
  • Autenticazione OAuth 2.0 come le altre API (sezione 1).
  • Per Siris App usare id_app = 49 (stesso valore della pagina app/custom/siris).
  • Prima dell'invio è consigliato 7.3 CheckAccount se serve sapere se l'email esiste.
  • Se l'account non ha ancora un player_id OneSignal valido (app non aperta / consenso notifiche), compare in no_player e non riceve la push.

L'endpoint interno area riservata app/sendNotification (usato dalla UI) lavora con id_account. Questa API pubblica accetta principalmente email; opzionalmente anche id_account.

7.5 Elenco account app per id_app

Restituisce gli account legati a un'id_app (stesso elenco della tab Account/Clienti in app/custom/siris). Utile per lo stato "App scaricata" senza chiamare CheckAccount uno-a-uno.

POST
https://api.infodrive.it/app/ListAccounts/
  • Siris App: id_app = 49.
  • has_onesignal = true indica consenso/dispositivo push registrato.
  • only_with_push = true filtra solo account con player OneSignal (come l'elenco notifiche UI).
7.6 Verifica account massiva (CheckAccounts)

Verifica fino a 500 email in una sola chiamata. Con id_app arricchisce ogni riga con app_linked e has_onesignal.

POST
https://api.infodrive.it/app/CheckAccounts/
7.7 Crea offerta (CreateOffer)

Pubblica un'offerta in vetrina app (app_vetrina_offerte), equivalente a "Gestisci Offerte" in Siris. L'immagine non è una colonna separata: come in UI, si inserisce come tag <img> nella descrizione (campo image_url).

POST
https://api.infodrive.it/app/CreateOffer/

Upload file: usare l'upload AWS già usato da Siris (https://servizi.infodrive.it/web/api/aws/cloud/1.0/upload.php), poi passare l'URL restituito in image_url.

7.8 Aggiorna offerta (UpdateOffer)

Aggiorna un'offerta esistente. Richiede id (o id_offerta) e id_app. Campi omessi restano invariati; attiva/active controlla la visibilità in app.

POST
https://api.infodrive.it/app/UpdateOffer/
7.9 Elenco offerte (ListOffers)

Elenco offerte vetrina per id_app. Con active_only=true restituisce solo quelle visibili in app.

POST
https://api.infodrive.it/app/ListOffers/

8 Satellitari

8.1 Attivazione sat (Insert)

Abbina un IMEI libero a cliente/veicolo. Il campo sat.type è l'id di aa_sat_modello (stesso valore di aa_sat_type_fu.FK_product_model), non il cod delle card GPS (gps_obd_standard 555, gps_filare_standard 556, gps_ghost 731) e non il default 1.

POST
https://api.infodrive.it/sat/Insert/
  • Mapping hardware: satellitari.modello = aa_sat_modello.nome_modello → aa_sat_modello.id = sat.type.
  • sat/Free/ restituisce anche type, modello, nome_modello per ogni IMEI libero.
  • products/List/ include le righe type: "sat" con il cod da usare in Insert (listino aa_sat_type_fu dell'utente OAuth).
  • Se sat.type manca o vale 1, Infodrive lo ricava dall'IMEI. Durata (es. 60) deve comunque esistere a listino per quel type.

Errore 406 "Non disponi della tipologia di sat...": coppia utente OAuth + FK_product_model + duration assente in aa_sat_type_fu (active). Non usare i codici card 555/556/731.