API Spedmo REST

¿Buscas usar algunas de las características de Spedmo en tu propia aplicación? Entonces has venido al lugar correcto.

La API REST de Spedmo permite que las aplicaciones externas y los sitios web puedan integrarse con datos y servicios de Spedmo. La API es de uso gratuito y se puede encontrar una definición completa de los servicios proporcionados en nuestra interfaz de especificación de la interfaz de usuario Swagger UI , que también proporciona un arnés de prueba útil para probar y solucionar las características de la API.

Empezando

1. Obtenga una clave API (SPEDMO-API-KEY)

Antes de usar la API para su aplicación, se debe generar una clave API que proporcionará el mecanismo para identificar sus llamadas a la API desde otras aplicaciones. Para comenzar, simplemente inicie sesión en Spedmo con su cuenta y su clave API se puede generar desde la consola de administración de la API .

Su clave API será un UUID y se llama " SPEDMO-API-KEY " cuando se usa para transacciones con el servicio.

2. Probar que la clave es funcional con la API

La interfaz de especificación de API UI de Spedmo REST Swagger permite realizar pruebas web rápidas y sencillas de la API sin necesidad de configurar software personalizado y está disponible para que la utilice como una herramienta de depuración rápida y fácil para cualquier posible problema de integración que pueda ocurrir con su aplicación .

Con su clave API, debería poder probar News.api y verificar que su clave le permita obtener una respuesta del sistema. Simplemente ingrese su llave en el arnés y presione el botón " ¡Pruébelo! ". Si su prueba fue exitosa con el contenido devuelto, está listo para integrar funciones en su aplicación.

Alternativamente, la API puede ser golpeada usando una aplicación como CURL, como se muestra en el siguiente ejemplo.

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

Si su clave no arroja un resultado, verifique que haya seguido las instrucciones anteriores correctamente.

3. Obtención de una clave de Usuario para obtener datos personales (SPEDMO-ACCESS-KEY)

Para las características principales de la API REST, se requerirá una clave de usuario para leer los datos personales, como los datos de contacto del usuario y las contribuciones de los usuarios (vuelos, livetracks, etc.). Esta clave se obtiene solicitando a un usuario que permita el acceso a su aplicación, la clave una vez obtenida es válida indefinidamente, por lo que no es necesario volver a solicitar constantemente esta clave de un usuario una vez que su aplicación la haya recibido, debe almacenarse en algún lugar dentro de su aplicación o servicio.

Para presentarle al usuario la solicitud, simplemente muestre / enmarque la siguiente URL dentro de su aplicación https://www.spedmo.com/apiAuthorise.pg y presente su " API-API-SPEDMO " en el encabezado de la solicitud. Si desea eliminar la navegación Spedmo de la experiencia, simplemente agregue ' whitelabel = true ' como parámetro de solicitud.

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

La respuesta volverá como HTML y se debe presentar directamente para usar al usuario, un ejemplo del resultado esperado se muestra en el siguiente diagrama.

teléfono-api

Spedmo se encargará de procesar las entradas de los usuarios, su aplicación debe monitorear el encabezado de respuesta de la página y buscar la " TECLA DE ACCESO-SPEDMO ". Esta clave en combinación con su " SPEDMO-API-KEY " le permitirá a su aplicación usar todas las funciones de la API Spedmo REST.

4. Probar que una clave de usuario es funcional con la API

Con su clave de usuario, obtenga la información del miembro del usuario usando Member.api .

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

Para obtener documentación sobre todas las demás características de REST API, consulte la especificación API Swagger UI .