¿Qué necesito saber sobre la obsolescencia de la API Vapid?
Contexto
A partir del 1 de febrero de 2021, la API Vapid de Procore quedó obsoleta y se sustituyó por la nueva API Rest v1.0. La nueva API se basa en una arquitectura actualizada que admite el control de versiones de recursos y una funcionalidad ampliada. Aunque Procore continuará admitiendo los recursos de la API de Vapid y atenderá los defectos según sea necesario, todo el desarrollo de nuevas funciones para la API de Procore se realizará en Rest v1.0. Aunque es poco probable que este cambio afecte a la mayoría de los clientes de Procore, si desarrolla y mantiene integraciones personalizadas que utilizan la API, le recomendamos que revise este artículo para obtener más información sobre cómo este cambio podría afectar a su integración, así como los pasos para migrar a la nueva API Rest. v1.0.
Preguntas habituales
¿En qué se diferencia Rest v1.0 de Vapid?
Rest v1.0 es un superconjunto de la API Vapid. Todos los puntos finales de recursos disponibles en Vapid también están disponibles en Rest v1.0, con la misma funcionalidad.
¿Hay nuevos recursos a los que pueda acceder?
Esté atento a las notificaciones del Portal del Desarrollador de Procore [1] que anuncian el lanzamiento de nuevos recursos de la API Rest.
¿Hay cambios trascendentes en Rest v1.0 que deba tener en cuenta?
Rest v1.0 no contiene cambios trascendentes. Actualizar una aplicación para usar Rest v1.0 solo requiere cambiar las rutas que solicite (por ejemplo, /vapid/projects pasa a ser /rest/v1.0/projects).
¿Hay cambios en la forma en que se maneja la autenticación?
No. El punto de conexión de autenticación (por ejemplo, /oauth/authorize) sigue siendo el mismo en Rest, y los tokens de autenticación se comparten entre ambas API.
¿Cómo migro el código de mi aplicación a Rest v1.0?
Actualizar una aplicación que actualmente consume la API Vapid para usar Rest v1.0 es tan sencillo como cambiar las rutas que solicite. Actualice su integración para usar los recursos de Rest v1.0 cambiando el formato de las URL de punto de conexión de la API en su código de manera que utilicen el nuevo espacio de nombres (/rest) y el parámetro de versión (v1.0) como se muestra en el siguiente ejemplo.
/api.procore.com/vapid/projects
/api.procore.com/rest/v1.0/projects
Recomendamos probar el código actualizado en su entorno de pruebas de desarrollo para verificar que la integración funcionará correctamente con los puntos finales de recursos /rest/v1.0.
Nueva documentación para los desarrolladores de la API Rest v1.0
Toda la documentación para desarrolladores del portal Developer Portal se ha actualizado con el lanzamiento de Rest v1.0. Las páginas de referencia para los recursos de la API de Rest v1.0 están disponibles en la sección REFERENCIA del portal. Utilice el menú desplegable y seleccione Rest v1 para acceder al nuevo contenido de referencia.
Además, todas las guías de desarrollo de la API, los tutoriales y el material relacionado en la sección DOCS del portal se han actualizado con el lanzamiento de Rest v1.0. Todos los fragmentos de código y las muestras se han actualizado para reflejar el nuevo formato de URL del punto final.
Control de versiones de recursos de la API Rest
La nueva arquitectura de versiones de la API Rest permite un enfoque flexible de la gestión de versiones, ya que los recursos se versionan de forma independiente. Esto le permite elegir si quiere adoptar las nuevas versiones de los recursos (con cambios de ruptura), o quedarse con las que está utilizando actualmente. Utilice las nuevas versiones de los recursos a medida que se publiquen y actualice su código en consecuencia, o espere hasta que tenga más sentido para su línea de desarrollo particular. Consulte Rest API Overview para obtener información adicional.
Registro de cambios de la API Rest
La nueva función de registro de cambios, también disponible en el Portal del Desarrollador, le permite ver detalles sobre los cambios en los recursos individuales de la API. Consulte Rest API Overview para obtener más información.