Dalux Box i jego API - Jak pobrać listę dokumentów?
Dalux Box API python przykład

Dalux Box API – w jaki sposób pobrać listę dokumentów?

Co to jest Dalux Box?

Dalux Box to narzędzie, które ułatwia zarządzanie obiegiem dokumentów na budowie. Dzięki niemu można efektywnie zarządzać dokumentacją projektową, dostępną z poziomu przeglądarki lub aplikacji mobilnej. Funkcjonalności obejmują możliwość organizowania dokumentów, nadzorowanie aktualności wersji oraz udostępnianie ich zespołowi. Dalux Box pozwala na cyfrową kontrolę dokumentów, co minimalizuje ryzyko błędów wynikających z użycia nieaktualnych wersji. Więcej na temat Dalux Box znajdziesz w naszym artykule na ten temat. Teraz przejdziemy do meritum czyli Dalux Box API!

Czym jest API w aplikacjach webowych?

API (Application Programming Interface) to interfejs, który pozwala na komunikację pomiędzy różnymi aplikacjami. W kontekście aplikacji webowych API umożliwia integrację zewnętrznych systemów oraz automatyzację działań, takich jak pobieranie danych lub aktualizacja zasobów. Działanie API opiera się na zasadzie wysyłania żądań przez klienta (nasza aplikacja) do serwera, który zwraca odpowiedź z odpowiednimi danymi. Przykład wykorzystania api to pobranie listy dokumentów, co pozwala na analizę i dalsze przetwarzanie tych danych. Poczytaj więcej w naszym poprzednim artykule na temat RestAPI.

Wybór technologii – przykładowo Python

Python jest jednym z najpopularniejszych języków programowania wykorzystywanych do integracji z API. Jego prosta składnia, szeroka dostępność bibliotek oraz duże wsparcie społeczności sprawiają, że jest idealny do pracy z różnymi interfejsami API, w tym Dalux Box. W Pythonie dostępne są moduły, takie jak requests, które ułatwiają wysyłanie żądań HTTP do API i obsługę zwracanych odpowiedzi. Dodatkowo, Python jest elastyczny, dzięki czemu można w nim łatwo przetwarzać i analizować dane pobrane z Dalux Box.

Przykład kodu w Python – Dalux Box API

Do pobrania listy dokumentów z Dalux Box można skorzystać z API tej aplikacji. W Pythonie typowy kod oparty o requests może wyglądać następująco:

import requests
from tqdm import tqdm

Project_id = ""  #Podaj id projektu
file_area = ""  #Podaj id przestrzeni plików
access_token = ""  #Podaj swój token API (ustawienia dalux)

url = f'https://field.dalux.com/service/api/5.0/projects/{Project_id}/file_areas/{file_area}/files'
headers = {
  'X-API-KEY': access_token 
  'Content-Type': 'application/json'
}
items = []
last_url = ''

with tqdm(total=0, unit="page", leave=False) as pbar:
  while True: #Wykonuje na wszystkich stronach (paginacja)
    response = requests.get(url, headers=headers)  
    response_json = response.json()
    links = response_json.get('links')
    getitems = response_json.get('items')
    items.extend(getitems)

    last_url = url
    url = None
    for item in links:
      if(item['rel'] == 'nextPage'):
        url = item['href']

    pbar.update(1)
    if(url == None or url == last_url):
    	break

files = []
for item in items:
    data = item.get('data')
    if(data["deleted"] == True): 
		continue
    files.append(data)

#Wydrukuj tablicę        
print(files)

Ten kod jest punktem wyjścia do dalszego rozwoju, np. filtrowania wyników lub analizowania dokumentów zwróconych przez API. Jeżeli chcesz dowiedzieć się więcej to łap dokumentację. Zajedziesz tu wszystkie dostępne endpointy.

Podsumowanie

Dalux Box to potężne narzędzie do zarządzania dokumentacją na budowie, które dzięki integracji z API pozwala na automatyzację procesów i ułatwia dostęp do aktualnych informacji. API umożliwia zewnętrznym aplikacjom, takim jak te napisane w Pythonie, komunikację z Dalux Box, co otwiera szerokie możliwości w zakresie pobierania i przetwarzania danych. Wybór technologii, takich jak Python, sprawia, że integracja staje się prosta i intuicyjna, a przykładowy kod może służyć jako baza do dalszego rozwijania funkcji. Wykorzystanie api pozwala na optymalizację pracy, minimalizację błędów i łatwy dostęp do informacji, co jest kluczowe w branży budowlanej.

apicdedalux
Udostępnij:
Dalux Box API – w jaki sposób pobrać listę dokumentów?
Napisane przez
Michał Wrochna
Co myślisz o tym artykule?
0 reakcji
love
0
like
0
so-so
0
weakly
0
0 komentarzy
Najnowsze komentarze
  • Najnowsze komentarze
  • Najlepsze komentarze
Zaloguj się, aby dodać komentarz.
Prawa zastrzeżone Pi Corp sp. z o.o. copyright 2020-2022