API e webhook per l’integrazione in sistemi esterni
Le nostre API sono basate su REST e utilizzano il formato json come vettore. Esiste una specifica Open API 3.0.2 per tutte le nostre API e webhook, che può essere utilizzata dai nostri partner di integrazione per generare framework di modelli con controlli di tipo e wrapper API per i nostri endpoint all’interno dei loro strumenti.
La documentazione delle API e dei webhook viene generata da queste specifiche API aperte e resa disponibile ai nostri partner come parte del programma per sviluppatori ioki. Il programma ioki per gli sviluppatori fornisce anche l’accesso a un bug tracker condiviso e svolge un ruolo fondamentale nella comunicazione delle modifiche alle API. La documentazione consiste di API Guide, API Passenger, API Driver, API Platform e Webhook.
API Guide
La API Guide contiene le istruzioni per il corretto utilizzo
Passenger API
Permette lo sviluppo completo del client per i passeggeri del servizio a chiamata
Driver API
Fornisce tutti gli elementi necessari per scrivere un client driver
Platform API
Interfaccia per l’integrazione completa con backend di terze parti
Webhooks
Informazioni sugli eventi che hanno luogo nell’ecosistema ioki
Il programma per sviluppatori
La partecipazione al programma di ioki per sviluppatori è necessaria per l’integrazione delle nostre API.
È necessario un NDA (accordo di non divulgazione) con ioki: a seconda del vostro rapporto con ioki, il vostro key account manager, il contatto commerciale o il partner tecnico saranno lieti di guidarvi in questo semplice processo. L’NDA è necessario anche se state conducendo un’analisi dei requisiti o uno studio di fattibilità e dovete rivedere la documentazione con il vostro team. Una volta firmato l’NDA, creeremo per voi e per i membri del vostro team gli account per accedere alla nostra istanza GitLab per gli sviluppatori.
Questo account vi darà accesso alla documentazione API più recente e al bug tracker. Siamo molto rigorosi in questo processo, poiché le nostre API non sono pubbliche e di solito devono essere chiarite in anticipo a causa della loro complessità. Inoltre, anche se l’accesso alla documentazione e al bug tracker è la parte più ovvia, il programma per sviluppatori offre molto di più. Si ripaga ottimizzando i processi.
I vantaggi in sintesi
- Accesso a tutta la nostra documentazione: Linee guida API, Passenger API, Driver API, Platform API e Webhook
- Accesso a un issue tracker condiviso per rimanere aggiornati su domande, richieste e segnalazioni di bug
- Supporto tecnico: responsabile della corrispondenza con i vostri team di sviluppo
- Accesso a un ambiente di sviluppo personalizzato per il vostro caso d’uso
- Kickoff con uno sviluppatore ioki per fornire preziosi dettagli tecnici
- Durante la fase d’integrazione, supportiamo il vostro team di sviluppo con un video check-in settimanale da parte di uno sviluppatore senior: abbiamo scoperto che un dialogo regolare accelera enormemente il processo di sviluppo
API Guide
Le API di ioki hanno principi di progettazione comuni. Alcuni esempi sono: Quali intestazioni sono necessarie, come funziona la paginazione, come l’API rende visibili gli errori e molti altri argomenti. Alcune parti di questa documentazione possono essere rilevanti per la maggior parte, ma non necessariamente per tutte le API, gli endpoint e i casi d’uso.
Passenger API
Pasenger API è l’interfaccia che consente lo sviluppo completo di client per i passeggeri del servizio a chiamata. La maggior parte dei client di base consiste in un’interfaccia utente piuttosto semplice in cui l’utente può richiedere un viaggio da A a B, ottenere un semplice risultato e prenotare o rifiutare il viaggio. L’API offre molto di più: prenotazioni immediate o future in diverse aree geografiche, informazioni sul servizio pre-viaggio, valutazione, pagamento, mancia, visualizzazione della posizione del veicolo in avvicinamento, dettagli della stazione, informazioni sui pedoni, aggiornamenti in tempo reale e calcolo dell’orario, viaggi passati e futuri, ricevute e molto altro ancora. È possibile integrare tutte le funzionalità che abbiamo progettato.
Driver API
Questa API fornisce tutti gli elementi necessari per programmare un client per autisti. Potrebbe trattarsi di una semplice applicazione che elenca le destinazioni e gli orari degli autisti. Tuttavia, anche in questo caso è possibile fare di più: noi utilizziamo le nostre API e forniamo un client di riferimento con un sistema di navigazione turn-by-turn completo e una funzionalità di check-in/check-out per i passeggeri che accompagna l’autista dalla partenza dal deposito fino al suo ritorno.
Platform API
Mentre Passenger API e Driver API sono utilizzate dai clienti su dispositivi mobili, Platform API è la nostra interfaccia per l’integrazione completa con backend di terze parti. Con il nostro prodotto standard, cerchiamo di ottenere la parità funzionale e non c’è quasi nessuna funzione che non possa essere controllata tramite questa interfaccia. È possibile creare, modificare o eliminare tutti i tipi di risorse, ad esempio creare nuove stazioni, riconfigurare la flotta, impostare i turni e sincronizzare i database di distribuzione. La nostra piattaforma DRT è progettata per integrarsi con tutti i tipi di flussi di dati e casi d’uso. È possibile gestire più prodotti con più clienti e persino condividere i database degli utenti con diversi partner di integrazione. Per casi d’uso specifici, Platform API consente persino di emettere token di accesso per Driver API e Passenger API , se il backend deve agire per conto di passeggeri o conducenti specifici.
Webhooks
I webhook sono un modo comune per essere informati sugli eventi all’interno di un sistema. I nostri webhook vi permettono di rimanere aggiornati sui cambiamenti di stato, facilitando casi d’uso semplici come la lettura di singoli dati e complessi come l’attivazione di una logica da parte vostra che possa poi utilizzare le altre API. I webhook possono essere impostati manualmente, ma anche programmati tramite Platform API. Possono essere attivati ogni volta che accade qualcosa o limitati a eventi specifici. Sono protetti da una firma con un codice segreto condiviso. I webhook non consegnati vengono ripetuti utilizzando un algoritmo di backoff esponenziale. È anche possibile recuperare i dati mancanti tramite Platform API. Il payload del webhook non contiene strutture di dati annidate all’infinito (Platform API può essere utilizzata per recuperare dati aggiuntivi, se necessario) tuttavia, inviamo una rappresentazione serializzata completa dell’oggetto associato all’evento. I dati contenuti sono quindi sufficienti per la maggior parte dei casi d’uso.
Non esitate a contattare i nostri esperti per una consulenza
Unitevi a noi per plasmare il futuro della mobilità per il servizio di trasporto da voi attualmente offerto o per sviluppare nuove idee insieme ai nostri professionisti. Saremo lieti di ricevere un vostro messaggio.
