⚠️ W związku z wprowadzeniem APIv4, dalszy rozwój APIv2 został zakończony, a APIv2 będzie stopniowo wygaszane.
Z tego względu rekomendujemy wybór APIv4 przy tworzeniu nowych integracji.
Zachęcamy również do migracji istniejących integracji do APIv4, wszędzie tam, gdzie jest to możliwe.

Czym jest API?

API (Application Programming Interface) to interfejs, który umożliwia komunikację pomiędzy różnymi systemami. Dzięki API Twój system może automatycznie pobierać lub wysyłać dane do LangLion, bez konieczności wykonywania tych operacji ręcznie.

API v4 LangLion działa w oparciu o standard REST (Representational State Transfer). Komunikacja odbywa się za pomocą żądań HTTP, a dane przekazywane są w ustandaryzowanym formacie.

Dzięki temu API możesz np. zintegrować LangLion z własnym systemem, aplikacją, stroną internetową lub innym oprogramowaniem.

Dokumentacja API v4

Pełna dokumentacja API v4 dostępna jest pod adresem:

https://{id-instancji}.langlion.com/api/v4/docs

gdzie {id-instancji} należy zastąpić identyfikatorem swojej instancji LangLion.

Przykładowa dokumentacja dla instancji demonstracyjnej znajduje się tutaj:

https://demonstracyjna.langlion.com/api/v4/docs

Ważne: przed rozpoczęciem integracji warto dokładnie zapoznać się z dokumentacją. Znajdują się w niej pomocne informacje dotyczące sposobu działania API, dostępnych operacji oraz tego, czego można spodziewać się w odpowiedziach API. Pozwoli to uniknąć wielu problemów podczas tworzenia integracji.

API Reference

W dokumentacji, w zakładce „API Reference”, znajduje się pełna lista dostępnych endpointów wraz z ich opisem.

Dla każdego endpointu można znaleźć między innymi informacje dotyczące:

  • sposobu wywołania endpointu,
  • wymaganych parametrów,
  • struktury requestu,
  • struktury response’u,
  • dostępnych danych i pól,
  • możliwych odpowiedzi API.

Przed implementacją konkretnej funkcji warto sprawdzić odpowiedni endpoint w zakładce „API Reference” i zapoznać się z jego pełnym opisem.

Generowanie kluczy API

Do komunikacji z API v4 potrzebne są klucze API. Możesz je wygenerować bezpośrednio w panelu administracyjnym LangLion.

Aby wygenerować nowy klucz:

  1. Przejdź do Administracja.
  2. Wybierz Ustawienia.
  3. Przejdź do sekcji Integracje.
  4. Wybierz API.
  5. Kliknij przycisk Generuj.

Ustawienia nowych kluczy API

Podczas tworzenia kluczy należy uzupełnić ich nazwę oraz wybrać odpowiedni zakres dostępu.

Nazwa kluczy API musi być pozbawiona znaków specjalnych. Zalecamy użycie prostej nazwy opisującej zastosowanie klucza, np. IntegracjaCRM lub SystemZewnetrzny.

Następnie w polu zakresu należy wybrać: apiv4

Po uzupełnieniu danych kliknij Generuj.

Użytkownik przypisany do kluczy API

Każdy zestaw wygenerowanych kluczy API jest przypisany do użytkownika, który go utworzył. Oznacza to, że klucze API dziedziczą uprawnienia tego użytkownika oraz jego dostęp do poszczególnych placówek.

Z tego względu rekomendujemy stworzenie dedykowanego użytkownika przeznaczonego do integracji, a następnie nadanie mu wyłącznie niezbędnego zakresu uprawnień oraz dostępu do konkretnych placówek, które mają być dostępne dla integracji.

Takie rozwiązanie pozwala ograniczyć zakres dostępu kluczy API i zwiększa bezpieczeństwo integracji.

Wygenerowane klucze API będą wykorzystywane do stworzenia tokenu, który będzie dołączany do każdego żądania API, aby uwierzytelnić naszą tożsamość.

W razie pytań zapraszamy do kontaktu pod adresem e-mail: developer@langlion.com