Overzicht en achtergrond
Fieldwire biedt een Open RESTful API (application program interface) aan klanten met eenPremier-abonnement of klanten die API-toegang aan hun Pro-/Business-abonnement hebben toegevoegd in overleg met ons verkoopteam.
Vraag een demo aanals u meer wilt weten over hoe u onze API kunt gebruiken en/of uw account wilt upgraden om er toegang toe te krijgen.
API-functionaliteit
Met onze API kunt u alles doen wat in de Fieldwire-gebruikersinterface kan (en meer), maar dan met programmeren! Sommige populaire manieren waarop klanten onze API gebruiken zijn bulkimport van de data van bestaande projecten vanuit andere systemen naar Fieldwire als ze overstappen naar ons platform, het synchroniseren van data tussen andere softwareplatforms en Fieldwire, het automatisch kopiëren van tekeningen en documenten in Fieldwire naar hun eigen servers en het analyseren van grote hoeveelheden data van meerdere projecten. En dat is pas het topje van de ijsberg.
- Bekijk onze API-documentatie
- Meld u aan voor e-mailmeldingen over de API-changelog
Hoe toegang voor ontwikkelaars te activeren en API-tokens te genereren voor uw Fieldwire-account
Accounteigenaren en -managers kunnen toegang voor ontwikkelaars aanvragen, API-tokens genereren, zien of API-toegang is in-of uitgeschakeld en onze API-documentatie bekijken onder het gedeelte 'API-instellingen' van het tabblad 'Account' op de Fieldwire-accountstartpagina.
Hoe toegang voor ontwikkelaars te activeren
1. Overleg met ons accountteam om een API-demo te krijgen en schaf een Fieldwire-premiumabonnement op maat met API-toegang aan.
2. Ga naar de startpagina van de Fieldwire-webversie, klik om uw 'Account'-tabblad te openen en blader naar het gedeelte 'API-instellingen' helemaal onderaan.
3. Klik op de link 'Verzoek API-toegang voor ontwikkelaars':
3. Er verschijnt een pop-up voor het versturen van een e-mail naar support@fieldwire.com om API-toegang voor ontwikkelaars aan te vragen. Beschrijf de context van uw verzoek en vergeet niet om op de blauwe 'Versturen'-knop te klikken:
4. Ons team zal (dezelfde dag) via e-mail reageren om te bevestigen dat we de API-toegang voor uw account hebben geactiveerd.
Hoe API-keys te genereren nadat we u toegang voor ontwikkelaars hebben verleend
1. Volg de bovenstaande instructies om de toegang voor ontwikkelaars geactiveerd te krijgen.
2. Als u nu weer naar hetzelfde gedeelte 'API-instellingen' onderaan het tabblad 'Account' op de Fieldwire-accountstartpagina gaat, zal de link voor 'Verzoek API-toegang voor ontwikkelaars' verdwenen zijn. (Als dat niet het geval is, moet u alsnog de bovenstaande instructies volgen om toegang aan te vragen). Als u ziet dat er in plaats daarvan een link voor 'Tokens beheren' staat, is alles in orde. Klik op die link om door te gaan:
3. Klik op 'Nieuw token' om een API-key voor uw account te genereren.
Opmerking: Er kunnen tot 10 API-keys per Fieldwire-account gegenereerd worden. Zorg ervoor dat deze veilig worden bewaard en alleen worden gedeeld met bevoegde personen.
4. Geef uw API-key een unieke naam en klik op 'Aanmaken'.
5. De volgende pop-up zal nu een uniek API-token laten zien. Zorg dat u dit token op een veilige plaats bewaart, want u kunt er niet meer bij nadat u de pop-up hebt gesloten.
Als u de pop-up per ongeluk sluit, kunt u de token intrekken en een nieuwe genereren.
Intrekken zal het oude token deactiveren, en u moet het overal waar u het gebruikt vervangen door uw nieuwe token.
Als u na het volgen van deze instructies nog problemen hebt met API-tokens, stuur dan een e-mail naar support@fieldwire.com.
API-ontwikkelaarspagina
Ga, nadat u toegang hebt gekregen tot onze API, naar onze API-ontwikkelaarsdocumentatie voor begeleiding.
Bekijk onze changelog om recente veranderingen in onze API-structuur te bekijken.
Meld u aan voor e-mailmeldingen over de API-changelog
Abonneer u op de RSS-feed-changelog.
Opmerking: API-calls voor aangepaste taakstatussen zijn op dit moment nog niet zichtbaar in onze API-ontwikkelaarsdocumentatie. Volg daarom deze gids voor API-calls voor aangepaste taakstatussen.
Meer informatie
- Wat kenmerkt een Premier-klant?
- Hoe kan ik de API-documentatiebekijken?