Zestaw narzędzi dla programistów (SDK)
SDK monday.com udostępnia zestaw narzędzi, których programiści mogą używać do tworzenia funkcji i rozwiązań opartych na monday.com. SDK przyda Ci się, jeśli chcesz:
- Uzyskiwać z aplikacji dostęp do danych konta monday.com za pomocą klienta GraphQL
- Tworzyć widoki tablic i widżety pulpitu, które rozszerzają interfejs monday.com
- Tworzyć integracje i automatyzacje z użyciem własnych usług zewnętrznych i logiki biznesowej
SDK zawiera metody do tworzenia aplikacji po stronie serwera i klienta. Funkcje po stronie klienta zakładają, że istnieje prawidłowa sesja użytkownika, i mogą bezproblemowo działać w jego imieniu. Możesz też używać metod po stronie serwera, aby uzyskiwać dostęp do funkcji monday.com za pomocą jawnie podanych poświadczeń, bez kodu po stronie klienta.
Korzystanie z SDK
Moduł npm
- Zainstaluj SDK jako moduł:
npm install monday-sdk-js --save
- Zaimportuj moduł do projektu:
import mondaySdk from "monday-sdk-js";
const monday = mondaySdk();
monday.setApiVersion("2023-10");
Bezpośrednio w kodzie HTML za pomocą znacznika <script>
- Dodaj poniższy kod, aby załadować SDK bezpośrednio do kodu HTML:
<head>
<script src="https://cdn.jsdelivr.net/npm/monday-sdk-js/dist/main.js"></script>
</head>
- Zainicjuj SDK w dowolnym miejscu na stronie, deklarując:
const monday = window.mondaySdk()
Bezproblemowe uwierzytelnianie
W przypadku tworzenia aplikacji po stronie klienta metody SDK, które wymagają działania w imieniu połączonego użytkownika, działają od razu dzięki komunikacji z nadrzędną aplikacją monday.com. Nie musisz inicjować klienta SDK przy użyciu jawnych poświadczeń.
Metody korzystające z bezproblemowego uwierzytelniania, w tym monday.api i monday.storage, zapewniają dostęp ograniczony uprawnieniami zalogowanego użytkownika oraz zakresami skonfigurowanymi w aplikacji.
Funkcje SDK
SDK udostępnia następujące funkcje:
| Obiekt SDK | Funkcja |
|---|---|
monday.api |
Wykonywanie zapytań do API monday.com w imieniu połączonego użytkownika |
monday.listen |
Nasłuchiwanie zdarzeń po stronie klienta monday.com, w którym działa ta aplikacja |
monday.get |
Pobieranie informacji z klienta monday.com, w którym działa ta aplikacja |
monday.execute |
Wywoływanie działania w kliencie monday.com, w którym działa ta aplikacja |
monday.storage |
Odczyt i zapis danych za pomocą Storage API, usługi przechowywania danych aplikacji w formacie klucz-wartość |
monday.set |
Konfigurowanie danych w aplikacji |
Obsługa TypeScript
SDK obsługuje TypeScript, nadzbiór języka JavaScript, który ułatwia programowanie. SDK wykorzystuje definicje typów, aby przed uruchomieniem kodu odróżniać kod poprawny od niepoprawnego. Dzięki temu możesz wcześniej wykrywać błędy.
Deklaracje typów dla poszczególnych metod SDK znajdziesz w pliku types/index.d.ts. Obsługa TypeScript jest dostępna od wersji SDK 0.3.0.
📘 Dołącz do naszej społeczności programistów!
Stworzyliśmy społeczność dla programistów, w której możesz przeszukiwać wcześniejsze dyskusje i znajdować rozwiązania, zadawać pytania, poznawać nowe funkcje i aktualizacje oraz zdobywać wskazówki i porady od innych programistów. Dołącz do nas! 😎