¿Qué necesito saber sobre la obsolescencia de la API Vapid?
Fondo
A partir del 1 de febrero de 2021, la API Vapid de Procore quedó obsoleta y se reemplazó 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 la funcionalidad ampliada. Aunque Procore continuará admitiendo los recursos de la API de Vapid y abordará 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 utilizando la API, le recomendamos que revise este artículo para obtener más información sobre cómo este cambio podría afectar su integración, así como los pasos para migrar a la nueva API Rest. v1.0.
Preguntas frecuentes
¿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?
Observe las notificaciones del Portal para programadores de Procore que anuncian el lanzamiento de nuevos recursos Rest API.
¿Hay cambios importantes en Rest v1.0 que deba tener en cuenta?
Rest v1.0 no contiene cambios importantes. Actualizar una aplicación para usar Rest v1.0 solo requiere cambiar las rutas que está solicitando (por ejemplo, /vapid/projects becomes /rest/v1.0/projects).
¿Hay cambios en la forma en que se maneja la autenticación?
No. El punto final 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 simple como cambiar las rutas que solicita. Actualice su integración para usar los recursos de Rest v1.0 cambiando el formato de las URL de punto final de la API en su código para usar 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 su código actualizado en su entorno de pruebas de desarrollo para verificar que su integración funcionará correctamente utilizando los puntos finales de recursos /rest/v1.0.
Documentación para programadores de la nueva API Rest v1.0
Se ha actualizado toda la documentación para programadores en el Portal para programadores con el lanzamiento de Rest v1.0. Las páginas de referencia para Rest v1.0 API recursos están disponibles en la sección REFERENCIA de la portal. Utilice el menú desplegable y seleccione Rest v1 para acceder al nuevo contenido de referencia.
Además, se han actualizado todas las guías de desarrollo API, tutoriales y material relacionado en la sección DOCS del portal con el lanzamiento de Rest v1.0.Se han actualizado todos los fragmentos de código y las muestras para reflejar el nuevo formato de URL de extremo.
Control de versiones de recursos de la API Rest
La nueva arquitectura de versión Rest API permite un enfoque flexible de la administración de versiones porque los recursos se versiónn de manera independiente de uno a otro. Esto le permite elegir si desea adoptar nuevas versiones de recursos (con cambios importantes) o permanecer con las que está utilizando actualmente. Utilice nuevas versiones de 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 tiempo de desarrollo en particular. Consulte Rest API Vista general de información adicional.
Registro de cambios de la API Rest
La nueva función de registro de cambios, también disponible en el Portal para programadores, le permite ver detalles sobre los cambios en los recursos de API individuales. Consulte Rest API Vista general de información adicional.