INTRODUCCION

Esta documentación tiene como fin brindar información sobre el uso de la API v3 de Sperant. Cubriremos todo lo que necesita saber, desde la autenticación hasta la manipulación de resultados.

La API Sperant proporcionan acceso para leer y escribir datos de Sperant. Puede gestionar clientes, proyectos, unidades y más. Las respuestas del servicio API están disponibles en JSON para una fácil lectura y manejo en los diferentes escenarios donde se consuma.

ESQUEMA

Todo el acceso a la API se realiza a través de HTTPS, y se accede a través de:

• Entorno de Prueba: https://api.eterniasoft.com

• Entorno de Producción: https://api.sperant.com

Todos los datos se envían y reciben como JSON.

AUTORIZACIÓN (Token)

El tipo de Autorización que utiliza el API es API Key, por lo que Sperant proporcionará un token único por aplicación y no caducará.

Para iniciar la integración y generación de token, el cliente inmobiliario deberá de solicitar un token de prueba a [e-mail].

Finalizada la integración con el token de prueba, el cliente inmobiliario deberá de solicitar a [e-mail] una reunión de validación, donde se realizarán pruebas en vivo. De no haber problemas en la integración, el equipo de Sperant enviará un nuevo token para el entorno de producción.

PAGINACIÓN

Las solicitudes que devuelven varios elementos se paginarán a 20 elementos de forma predeterminada.

Además, el ordenamiento de los listados se realiza por fecha de creación excepto el listado de clientes que se ordena por fecha de última interacción, ambos de forma descendente.

CONSIDERACIONES

• El cliente inmobiliario deberá de contar con ayuda técnica de una agencia digital o desarrollador que conozca sobre conexiones API REST y programación a nivel de backend.

• El consumo de la APIv3 solo se utiliza a nivel backend, debido a que estamos bloqueando CORS por un tema de seguridad.

• El arreglo de datos que envía su formulario a Sperant deberá de ser en formato JSON.

• El consumo de la API es a nivel de backend, deberá de utilizar un lenguaje de programación (r. PHP) para realizar peticiones.

• Sperant no administra ni distribuye plugins o conectores para integraciones con sitios web CMS (WordPress, Wix, Webnode, otros).

• Rate limit API -15 peticiones por segundo.

AYUDA Y SOPORTE

Siempre estamos felices de ayudarte con tus servicios a integrar, cualquier otra pregunta que puedas tener. Comunícate a través de un correo a [e-mail]