Überblick und Hintergrund
Fieldwire bietet eine offene RESTful-API (Anwendungsprogrammschnittstelle) für Kunden des Premium-Plans oder für Kunden, die den API-Zugang zu ihrem Pro/Business-Plan in Zusammenarbeit mit unserem Vertriebsteam hinzugefügt haben.
Bitte fordern Sie eine Demo an, wenn Sie mehr darüber erfahren möchten, wie Sie unsere API nutzen können und/oder Ihr Konto für den Zugriff darauf aktualisieren möchten.
Inhaltsübersicht
API-Funktionalität
Mit unserer API können Sie alles tun, was Sie in der Fieldwire-Benutzeroberfläche tun können (und mehr), aber mit Programmierung! Unsere Kunden nutzen die API unter anderem, um bestehende Projektdaten aus anderen Systemen in großem Umfang in Fieldwire zu importieren, wenn sie auf unsere Plattform umsteigen, um Daten zwischen anderen Softwareplattformen und Fieldwire zu synchronisieren, um Pläne und Dokumente von Fieldwire automatisch auf ihre eigenen Server zu kopieren und um große Datenmengen über mehrere Projekte hinweg zu analysieren.
- Zu unserer API-Dokumentation
- Für API Changelog E-Mail-Benachrichtigungen registrieren
Entwicklerzugang und API-Token
Mit der Rolle Kontobesitzer und -manager können Sie unter dem Abschnitt "API-Einstellungen" auf der Registerkarte "Konto" auf der Startseite Ihres Fieldwire-Kontos Entwicklerzugang beantragen, API-Tokens generieren, sehen, ob der API-Zugang aktiviert oder deaktiviert ist, und unsere API-Dokumentation einsehen.
Entwicklerzugang aktivieren
- Sprechen Sie mit unserem Account-Team, um eine API-Demo zu erhalten und ein individuelles Premium Fieldwire-Abonnement mit API-Zugang zu erwerben.
- Navigieren Sie zur Startseite von Fieldwire Web, klicken Sie auf die Registerkarte "Konto" und scrollen Sie nach unten zum Abschnitt "API-Einstellungen".
- Klicken Sie auf den Link "API-Entwicklerzugang anfordern":
- Es erscheint ein Popup-Fenster mit der Aufforderung, eine E-Mail an support@fieldwire.com zu senden. Bitte geben Sie den Kontext für Ihre Anfrage an und klicken Sie auf die blaue Schaltfläche "Senden":
- Unser Team wird Ihnen per E-Mail antworten und bestätigen, dass wir den API-Zugang für Ihr Konto aktiviert haben.
API-Schlüssel generieren
1. Folgen Sie den obigen Schritten, um den Entwicklerzugang zu erhalten.
2. Wenn Sie zum Abschnitt "API-Einstellungen unten" auf der Registerkarte Konto Ihrer Fieldwire-Startseite navigieren, ist der Link für "API-Entwicklerzugang anfordern" nicht mehr vorhanden. (Wenn dies nicht der Fall ist, müssen Sie immer noch die oben genannten Anweisungen befolgen, um den Zugang zu beantragen). Wenn Sie stattdessen einen Link zu "Tokens verwalten" sehen, können Sie loslegen. Klicken Sie auf diesen Link, um fortzufahren:
3. Klicken Sie "+ neues Token", um das API-Token für Ihr Konto zu generieren
Hinweis: Es können bis zu 10 API-Schlüssel pro Fieldwire-Konto generiert werden. Bitte stellen Sie sicher, dass diese sicher aufbewahrt und nur an autorisierte Personen weitergegeben werden.
4. Geben Sie Ihrem API-Token einen eindeutigen Namen und klicken Sie dann auf "Erstellen".
5. Das folgende Popup-Fenster zeigt nun ein eindeutiges API-Token an. Bewahren Sie dieses Token an einem sicheren Ort auf, da Sie nach dem Schließen des Popup-Fensters nicht mehr darauf zugreifen können.
Wenn Sie das Popup versehentlich schließen, können Sie das Token widerrufen und ein neues generieren.
Wenn Sie das Popup versehentlich schließen, können Sie das Token widerrufen und ein neues generieren.
API Token verwalten
Bestehende Token einsehen und widerrufen oder ein neues Token für das Konto erstellen.
Hinweis: Durch das Widerrufen wird das alte Token deaktiviert, so dass alle Instanzen, in denen es verwendet wurde, mit dem neuen Token aktualisiert werden sollten.
Wenn Sie nach Befolgung dieser Anweisungen Probleme mit API-Tokens haben, senden Sie bitte eine E-Mail an support@fieldwire.com
API Developer Page (Entwicklerseite)
- Sobald Sie Zugang zu unserer API haben, finden Sie in unserem API-Entwickler-Dokument eine Anleitung.
- Um die letzten Änderungen in der API-Struktur zu sehen, sehen Sie bitte in unserem Changelog nach.
- Registrieren Sie sich für API Changelog E-Mail-Benachrichtigungen
- Sie können außerdem den RSS feed changelog abonnieren.
Hinweis: Benutzerdefinierte Aufgabenstatus-API-Aufrufe sind in unserem Dokument für API-Entwickler noch nicht sichtbar. Bitte beachten Sie diesen Leitfaden für CTS-API-Aufrufe.