Przegląd
Fieldwire udostępnia otwarty interfejs API RESTful (interfejs programowania aplikacji) klientom objętym umową na poziomie korporacyjnym lub tym, którzy dodali dostęp do interfejsu API do swojego planu Pro/Business/Business Plus w porozumieniu z naszym zespołem sprzedaży. (Sprawdź naszą stronę z cennikiem, aby uzyskać więcej informacji).
Zamów prezentację, jeśli chcesz dowiedzieć się więcej o tym, jak możesz korzystać z naszego API i/lub zaktualizować swoje konto, aby uzyskać do niego dostęp!
Spis treści
Funkcje API
Nasze API pozwala na te same czynności, które są dostępne w interfejsie użytkownika Fieldwire (i więcej), ale dzięki dodaniu nowego kodu! Niektóre z popularnych sposobów, w jakie nasi klienci korzystają z API, to masowy import istniejących danych projektowych z innych systemów do Fieldwire podczas migracji na naszą platformę, synchronizacja danych między innymi platformami oprogramowania a Fieldwire, automatyczne kopiowanie rysunków i dokumentów Fieldwire na własne serwery oraz analizowanie dużych ilości danych z wielu projektów.
- Zobacz dokumentację API
- Zarejestruj się, aby otrzymywać powiadomienia e-mail API Changelog
Dostęp dla deweloperów i klucze API
Właściciele i menedżerowie kont mogą poprosić o dostęp dla deweloperów, wygenerować tokeny API, sprawdzać, czy dostęp do API jest włączony lub wyłączony, a także wyświetlić naszą dokumentację API w sekcji „Ustawienia API” w zakładce „Konto” na stronie głównej konta Fieldwire.
Jak aktywować dostęp dla deweloperów
1. Porozmawiaj z naszym zespołem ds. kont, aby uzyskać wersję demonstracyjną API i zakupić niestandardową subskrypcję Premium Fieldwire z dostępem do API.
2. Przejdź do strony głównej na stronie Fieldwire, kliknij, aby wyświetlić zakładkę „Konto” i przewiń w dół do sekcji „Ustawienia API” na samym dole.
3. Kliknij odnośnik „Poproś o dostęp do API dla deweloperów”:
3. Pojawi się wyskakujące okienko do wysłania wiadomości e-mail support@fieldwire.com. Podaj kontekst swojej prośby i kliknij niebieski przycisk „Wyślij”:
4. Nasz zespół odpowie, aby potwierdzić, że aktywowaliśmy dostęp API do konta.
Jak wygenerować klucze API
1. Postępuj zgodnie z powyższymi instrukcjami, aby uzyskać dostęp dla deweloperów.
2. Gdy przejdziesz do sekcji Ustawienia API w dolnej części zakładki Konto na stronie głównej Fieldwire, odnośnik „Poproś o dostęp do API dla deweloperów” zniknie. (Jeśli tak nie jest, należy postępować zgodnie z powyższymi instrukcjami, aby uzyskać dostęp). Jeśli w jego miejscu jest widoczny odnośnik „Zarządzaj tokenami”, to wszystko jest w porządku. Kliknij odnośnik, aby kontynuować:
3. Kliknij „Nowy token”, aby wygenerować klucz API do konta.
Uwaga: W ramach jednego konta Fieldwire można wygenerować do 10 kluczy API. Upewnij się, że są one bezpiecznie przechowywane i udostępniane wyłącznie upoważnionym osobom.
4. Nadaj swojemu kluczowi API unikalną nazwę, a następnie kliknij przycisk „Utwórz”.
5. W oknie pojawi się unikalny token API. Pamiętaj, aby zachowywać ten token w bezpiecznym miejscu, ponieważ nie będziesz mieć do niego dostępu po zamknięciu wyskakującego okienka.
Jeśli przypadkowo zamkniesz wyskakujące okienko, możesz anulować token i wygenerować nowy.
Uwaga: Anulowanie spowoduje dezaktywację starego tokena, więc wszystkie miejsca, w których był on używany, powinny zostać zaktualizowane nowym tokenem.
Jeśli masz jakiekolwiek problemy z tokenami API po wykonaniu tych instrukcji, wyślij wiadomość e-mail na adres support@fieldwire.com.
Strona API dla deweloperów
- Po uzyskaniu dostępu do naszego API, zapoznaj się z dokumentacją API dla deweloperów w celu uzyskania informacji.
- Aby zobaczyć ostatnie zmiany w strukturze API, przejrzyj nasz changelog.
- Zarejestruj się, aby otrzymywać powiadomienia e-mail API Changelog, jeśli chcesz.
- Podobnie, możesz zasubskrybować kanał RSS changelog.
Uwaga: Wywołania Statusu niestandardowego zadania API nie są jeszcze widoczne w naszym dokumencie API dla deweloperów. Pamiętaj, aby postępować zgodnie z tym przewodnikiem dla wywołań API CTS.