Was muss ich über die Abkündigung der Vapid-API wissen?
Hintergrund
Seit dem 1. Februar 2021 wurde die Vapid-API von Procore abgekündigt und durch die neue Rest-API v1.0 ersetzt. Die neue API basiert auf einer moderneren Architektur, die die Versionierung von Ressourcen und erweiterte Funktionen unterstützt. Obwohl Procore die Vapid-API-Ressourcen weiterhin unterstützen und Fehler nach Bedarf beheben wird, wird die gesamte Entwicklung neuer Funktionen für die Procore-API in Rest v1.0 erfolgen. Obwohl diese Änderung für die meisten Procore-Kunden keine Auswirkungen haben dürfte, empfehlen wir Ihnen, diesen Artikel zu lesen, falls Sie benutzerdefinierte Integrationen unter Verwendung der API entwickeln und verwalten. Dabei erfahren Sie mehr darüber, wie sich diese Änderung auf Ihre Integration auswirken könnte, sowie über die Schritte zur Migration auf die neue Rest-API v1.0.
Allgemeine Fragen
Wie unterscheidet sich Rest v1.0 von Vapid?
Rest v1.0 ist ein Superset der Vapid-API. Alle in Vapid verfügbaren Ressourcen-Endpunkte sind auch in Rest v1.0 mit der gleichen Funktionalität verfügbar.
Gibt es neue Ressourcen, auf die ich zugreifen kann?
Achten Sie auf Benachrichtigungen vom Procore-Entwicklerportal. Auf dieser Seite wird die Veröffentlichung neuer Rest-API-Ressourcen angekündigt.
Gibt es wesentliche Änderungen in Rest v1.0, die ich berücksichtigen muss?
Rest v1.0 enthält keine wesentlichen Änderungen. Um eine Anwendung auf die Nutzung von Rest v1.0 zu aktualisieren, müssen lediglich die von Ihnen angeforderten Routen geändert werden (z. B. wird /vapid/projects zu /rest/v1.0/projects).
Gibt es Änderungen im Umgang mit der Authentifizierung?
Nein. Der Authentifizierungsendpunkt (z. B. /oauth/authorize) bleibt in Rest derselbe, und die Authentifizierungstoken werden von beiden APIs gemeinsam genutzt.
Wie migriere ich meinen Anwendungscode zu Rest v1.0?
Das Upgrade einer Anwendung, die derzeit die Vapid-API verwendet, auf Rest v1.0 ist so einfach wie das Ändern der von Ihnen angeforderten Routen. Aktualisieren Sie Ihre Integration auf die Nutzung von Rest v1.0-Ressourcen, indem Sie das Format der API-Endpunkt-URLs in Ihrem Code so ändern, dass der neue Namespace (/rest) und der Versionsparameter (v1.0) verwendet werden, wie im folgenden Beispiel gezeigt.
/api.procore.com/vapid/projects
/api.procore.com/rest/v1.0/projects
Wir empfehlen Ihnen, Ihren neuen Code in Ihrer Development-Sandbox zu testen, um sicherzustellen, dass Ihre Integration mit den Ressourcenendpunkten /rest/v1.0 ordnungsgemäß funktioniert.
Neue Entwicklerdokumentation für die Rest v1.0-API
Die gesamte Entwicklerdokumentation auf dem Entwicklerportal wurde mit der Veröffentlichung von Rest v1.0 aktualisiert.Referenzseiten für Rest v1.0-API-Ressourcen sind im Abschnitt REFERENCE des Portals verfügbar.Verwenden Sie das Dropdown-Menü und wählen Sie Rest v1, um auf die neuen Referenzinhalte zuzugreifen.
Darüber hinaus wurden alle API-Entwicklungsleitfäden, Tutorials und zugehöriges Material im Abschnitt DOCS des Portals mit der Veröffentlichung von Rest v1.0 aktualisiert.Alle Codeschnipsel und Beispiele wurden aktualisiert, um das neue Endpunkt-URL-Format zu berücksichtigen.
Versionierung von Rest-API-Ressourcen
Die neue Versionsarchitektur der Rest-API ermöglicht einen flexiblen Ansatz für die Versionsverwaltung, da die Ressourcen unabhängig voneinander versioniert werden. So können Sie wählen, ob Sie neue Ressourcenversionen (mit wesentlichen Änderungen) übernehmen oder bei den derzeit verwendeten Versionen bleiben möchten. Verwenden Sie neue Ressourcenversionen, sobald sie veröffentlicht werden, und aktualisieren Sie Ihren Code entsprechend, oder warten Sie, bis es für Ihren speziellen Entwicklungszeitplan sinnvoller ist. Weitere Informationen finden Sie unter Rest API-Überblick.
Changelog der Rest-API
Die neue Changelog-Funktion, die auch im Entwicklerportal verfügbar ist, ermöglicht es Ihnen, Details zu Änderungen an einzelnen API-Ressourcen anzuzeigen. Weitere Informationen finden Sie unter Rest API-Überblick.