API REST di Spedmo

Cerchi di utilizzare alcune funzionalità di Spedmo nella tua applicazione? Allora sei nel posto giusto.

L'API Spedmo REST consente alle applicazioni e ai siti Web esterni di integrarsi con i dati e i servizi di Spedmo. L'API è gratuita e una completa definizione dei servizi forniti può essere trovata nell'interfaccia delle specifiche API UI Swagger che fornisce anche un utile cablaggio di test per le funzionalità di test e risoluzione dei problemi dell'API.

Iniziare

1. Ottieni una chiave API (SPEDMO-API-KEY)

Prima di utilizzare l'API per l'applicazione, è necessario generare una chiave API che fornisca il meccanismo per identificare le chiamate all'API da altre applicazioni. Per iniziare, è sufficiente accedere a Spedmo con il proprio account e la chiave API può essere generata dalla console di gestione API .

La chiave API sarà un UUID e viene chiamata " SPEDMO-API-KEY " quando viene utilizzata per le transazioni con il servizio.

2. Verificare che la chiave sia funzionante con l'API

L' interfaccia API SPI Swagger di Spedmo REST consente l'esecuzione di test Web rapidi e facili dell'API senza la necessità di configurare software personalizzato ed è disponibile per l'utilizzo come strumento di debug rapido e semplice per eventuali problemi di integrazione che potrebbero verificarsi con l'applicazione .

Con la tua chiave API dovresti essere in grado di testare News.api e controllare che la tua chiave ti permetta di ottenere una risposta dal sistema. Basta inserire la chiave nell'imbracatura e premere il pulsante " Provalo! ". Se il test ha avuto successo con il contenuto restituito, sei pronto per integrare le funzionalità nella tua app.

In alternativa, l'API può essere colpita utilizzando un'applicazione come CURL, come mostrato nell'esempio seguente.

curl -X GET --header 'Accetta: application / json' --header 'SPEDMO-API-KEY: YOUR-KEY-HERE ' 'https://www.spedmo.com/api/v1.0/news.api '

Se la tua chiave non restituisce un risultato, controlla di aver seguito correttamente le istruzioni sopra.

3. Ottenere un codice utente per ottenere dati personali (SPEDMO-ACCESS-KEY)

Per le caratteristiche principali dell'API REST, sarà richiesta una chiave utente per leggere i dati personali come i dettagli di contatto dell'utente e i contributi degli utenti (voli, piste da concerto ecc.). Questa chiave è ottenuta richiedendo un accesso utente alla tua applicazione, la chiave una volta ottenuta è valida a tempo indeterminato quindi non c'è bisogno di richiedere continuamente questa chiave da un utente una volta che la tua applicazione lo ha ricevuto, dovrebbe essere memorizzato da qualche parte all'interno del tuo app o servizio.

Per presentare all'utente la richiesta, è sufficiente visualizzare / incorniciare il seguente URL all'interno dell'applicazione https://www.spedmo.com/apiAuthorise.pg e presentare la " SPEDMO-API-KEY " nell'intestazione della richiesta. Se desideri rimuovere Spedmo Navigation dall'esperienza, aggiungi semplicemente " whitelabel = true " come parametro di richiesta.

curl -X GET --header 'Accetta: application / json' --header 'SPEDMO-API-KEY: YOUR-KEY-HERE ' 'https://www.spedmo.com/apiAuthorise.pg?whitelabel=true'

La risposta tornerà come HTML e dovrebbe essere presentata direttamente per l'uso dell'utente, un esempio di output atteso è mostrato nel diagramma sottostante.

phone-api

Spedmo si occuperà di elaborare gli input degli utenti, l'applicazione dovrebbe monitorare l'intestazione della risposta della pagina e cercare " SPEDMO-ACCESS-KEY ". Questa chiave in combinazione con il tuo " SPEDMO-API-KEY " consentirà alla tua applicazione di utilizzare tutte le funzionalità dell'API REST di Spedmo.

4. Verificare che una chiave utente sia funzionante con l'API

Con la tua chiave utente ottieni le informazioni sui membri degli utenti usando Member.api .

curl -X GET --header 'Accetta: application / json' --header 'SPEDMO-ACCESS-KEY: USER-KEY-HERE ' --header 'SPEDMO-API-KEY: YOUR-KEY-HERE ' 'https: / /www.spedmo.com/api/v1.0/member.api'

Per la documentazione su tutte le altre funzionalità dell'API REST, consultare le specifiche API UI Swagger .