AlisQI (wersja zapoznawcza)
Zintegruj usługę QMS z systemem ERP, MES, PLM, instrumentami, czujnikami lub witryną internetową przy użyciu narzędzi łączności AlisQI.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Obsługa interfejsu AlisQI |
| adres URL | https://help.alisqi.com/ |
| support@alisqi.com |
| Metadane łącznika | |
|---|---|
| Publisher | AlisQI BV |
| Witryna internetowa | https://www.alisqi.com |
| Zasady ochrony prywatności | https://www.alisqi.com/en/privacy-statement |
| Kategorie | Zarządzanie biznesem |
AlisQI
Zintegruj usługę QMS z systemem ERP, MES, PLM, instrumentami, czujnikami lub witryną internetową przy użyciu narzędzi łączności AlisQI.
Wydawca: AlisQI B.V.
Wymagania wstępne
Aby użyć tego łącznika, potrzebne będą następujące elementy:
- Konto z AlisQI.
- Po zarejestrowaniu się i utworzeniu aplikacji pobierz klucz interfejsu API z portalu online; Użyjesz tego klucza do uwierzytelnienia żądań z naszego łącznika AlisQI.
Obsługiwane operacje
Łącznik obsługuje następujące operacje:
Pobieranie wyników lub danych
/getResultsgłównych: pobieranie wyników (jakości) z zestawów analiz lub danych głównych z list wyboru.Pobierz wszystkie zestawy analiz lub listy
/getAllSetswyboru: pobierz listę (wszystkich) zestawów analiz lub list wyboru.Tworzenie lub aktualizowanie wyników lub danych
/storeResultsgłównych: wyniki tworzenia lub aktualizowania jakości w zestawach analiz lub danych głównych na listach wyboru.Uzyskiwanie opisowych statystyk dla pól
/getStatisticszestawu analiz: pobierz opisowe statystyki dla wybranego pola zestawu analiz liczbowych.Uzyskiwanie statystyk możliwości dla pól
/getSpecificationEvaluationzestawu analiz: uzyskaj szczegółowe statystyki dotyczące oceny specyfikacji i możliwości przetwarzania dla pól liczbowych zestawu analiz.Pobierz wersje specyfikacji: pobierz (a) wersje
/getSpecificationVersionspecyfikacji dla zestawu analiz.Utwórz nową wersję
/storeSpecificationVersionspecyfikacji: utwórz (a) nowe wersje specyfikacji dla zestawów analiz.Pobierz strukturę zestawów analiz lub listy
/getSetDefinitionwyboru: pobierz definicję strukturalną zestawów analiz lub list wyboru.
Uzyskiwanie poświadczeń
Wszystkie wywołania interfejsu API podlegają uwierzytelnianiu. Aby wywołać punkty końcowe interfejsu API AlisQI, deweloperzy muszą utworzyć token uwierzytelniania.
Interfejs API obsługuje specyfikację uwierzytelniania elementu nośnego.
Każdy token jest połączony z jednym użytkownikiem. Uprawnienie Odczyt, Wstawianie i aktualizowanie, które ma ten użytkownik do zestawów analiz (za pośrednictwem grupy użytkowników), ma również zastosowanie do wywołań interfejsu API. Więcej informacji na temat zarządzania użytkownikami i uprawnieniami w narzędziu AlisQI.
Tokeny uwierzytelniania interfejsu API można utworzyć w centrum integracji w aplikacji. Zalecamy używanie dedykowanych tokenów na scenariusz integracji.
Alternatywnie, jeśli metoda uwierzytelniania elementu nośnego jest niedostępna, żądania można uwierzytelnić przy użyciu parametru
&accessToken=abc...123accessToken URL .
Znane problemy i ograniczenia
Filtry: Operacje z parametrem filtru oczekują ciągu JSON reprezentującego filtr. Użyj centrum integracji w aplikacji, aby utworzyć filtr i skopiować ciąg JSON.
Daty: wszystkie daty i godziny są w formacie UTC (sformatowane jako
yyyy-mm-dd hh:mm:ss), a wszystkie ciągi są kodowane przy użyciu formatu UTF-8.Buforowanie: operacja getResults obsługuje walidację pamięci podręcznej przy użyciu elementu ETag i nagłówków Last-Modified. Zalecamy włączenie buforowania na klientach i wykonywanie żądań warunkowych w celu zmniejszenia opóźnienia, obciążenia serwera i zużycia energii.
Limity użycia: wcześniej zaobserwowano obniżenie wydajności z powodu przeciążenia interfejsu API. Aby zapewnić stabilność naszych limitów użycia platformy, mają zastosowanie do interfejsu API. Te limity zostały zaprojektowane tak, aby zapobiec niepożądanym obciążeniom w naszych systemach przed błędnie skonfigurowanymi integracją interfejsu API lub nadużyciami. Limit szybkości domyślnie wykonuje 30 wywołań na minutę. Dotyczy to zarówno operacji odczytu, jak i zapisu. Żądania, które osiągną limit szybkości, będą miały kod
429 Too many requestsstanu .
Wszystkie odpowiedzi obejmują następujące nagłówki z jawnymi numerami limitów i pozostałych wywołań:
- X-RateLimit-Limit
- X-RateLimit-Remaining
- X-RateLimit-Retry-After
Aby debugować problemy w scenariuszach integracji, które są lub mogą być spowodowane przez limity szybkości, zapoznaj się z tą listą kontrolną:
- Skontaktuj się ze specjalistą ds. integracji, aby sprawdzić wywołania interfejsu API i zwracać nagłówki.
- Otwórz centrum integracji AlisQI, aby dowiedzieć się więcej o konkretnym limicie szybkości zastosowanym do instalacji.
- Sprawdź dziennik interfejsu API w centrum integracji AlisQI, aby określić liczbę żądań na minutę.
- Sprawdź nagłówki zwracane żądania interfejsu API, aby sprawdzić, czy zawierają
429 Too many requestskod stanu. - Sprawdź poszczególne nagłówki zwracane żądania interfejsu API, aby ocenić
X-RateLimit-* headerselement . - Oceń, czy można ulepszyć integrację, zmniejszając liczbę zduplikowanych żądań, czy łącząc wiele wyników w jednym wywołaniu storeResults. Możesz skontaktować się z pomocą techniczną usługi AlisQI, aby omówić możliwości naszego interfejsu API dotyczące buforowania i przetwarzania wielu wyników.
- Jeśli scenariusz integracji jest zoptymalizowany, ale legalnie wymaga więcej wywołań na minutę, skontaktuj się z pomocą techniczną usługi AlisQI, aby omówić możliwości podniesienia limitu.
Instrukcje dotyczące wdrażania
Skorzystaj z tych instrukcji , aby wdrożyć ten łącznik jako łącznik niestandardowy w usługach Microsoft Flow i PowerApps.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Klucz interfejsu API | securestring | Klucz interfejsu API dla tego interfejsu API | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Pobieranie statystyk możliwości dla pól zestawu analiz |
Uzyskaj szczegółowe statystyki dotyczące możliwości oceny specyfikacji i produktu i procesu dla pól liczbowych zestawu analiz. |
| Pobieranie struktury zestawów analiz lub listy wyboru |
Pobierz definicję strukturalną zestawów analiz lub list wyboru. |
| Pobieranie wersji specyfikacji |
Pobierz (a) wersje specyfikacji dla zestawu analiz. |
| Pobieranie wszystkich zestawów analiz lub list wyboru |
Pobierz listę (wszystkich) zestawów analiz lub list wyboru. |
| Pobieranie wyników lub danych głównych |
Pobieranie wyników (jakości) z zestawów analiz lub danych głównych z list wyboru. |
| Tworzenie lub aktualizowanie wyników lub danych głównych |
Tworzenie lub aktualizowanie wyników dotyczących jakości w zestawach analiz lub danych głównych na listach wyboru. |
| Tworzenie nowej wersji specyfikacji |
Utwórz (a) nowe wersje specyfikacji dla zestawów analiz. |
| Uzyskiwanie opisowych statystyk dla pól zestawu analiz |
Uzyskaj opisowe statystyki dla wybranego pola zestawu analiz liczbowych. |
Pobieranie statystyk możliwości dla pól zestawu analiz
Uzyskaj szczegółowe statystyki dotyczące możliwości oceny specyfikacji i produktu i procesu dla pól liczbowych zestawu analiz.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
Poddomena, która ma być używana dla żądania. |
|
Identyfikator zestawu
|
setId | True | integer |
Wprowadź unikatowy identyfikator interesującego Cię zestawu analiz (historycznie znany jako maskid w adresach URL). |
|
Pola formularza
|
fields | True | string |
Rozdzielona przecinkami lista z określonymi punktami danych, które chcesz zwrócić. |
|
Ograniczenie
|
limit | integer |
Maksymalna liczba wyników do rozważenia. |
|
|
Filter
|
filter | string |
Użyj ciągu sformatowanego w formacie JSON, aby zawęzić żądane dane na podstawie określonych warunków. |
Pobieranie struktury zestawów analiz lub listy wyboru
Pobierz definicję strukturalną zestawów analiz lub list wyboru.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
Poddomena, która ma być używana dla żądania. |
|
Identyfikator zestawu
|
setId | True | integer |
Wprowadź unikatowy identyfikator interesującego Cię zestawu analiz (historycznie znany jako maskid w adresach URL). |
|
Tylko aktywne pola
|
onlyActiveFields | boolean |
Czy pokazywać tylko aktualnie aktywne pola. |
|
|
Akceptuj
|
Accept | True | string |
Akceptuj |
Pobieranie wersji specyfikacji
Pobierz (a) wersje specyfikacji dla zestawu analiz.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
Poddomena, która ma być używana dla żądania. |
|
Identyfikator zestawu
|
setId | True | integer |
Wprowadź unikatowy identyfikator interesującego Cię zestawu analiz (historycznie znany jako maskid w adresach URL). |
|
Wartość indeksu
|
indexValue | string |
Pobierz bieżącą wersję specyfikacji dla tej wartości indeksu. |
Pobieranie wszystkich zestawów analiz lub list wyboru
Pobierz listę (wszystkich) zestawów analiz lub list wyboru.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
Poddomena, która ma być używana dla żądania. |
|
Groups
|
groups | string |
Wprowadź identyfikatory grup lub nazwy, aby znaleźć określone grupy, użyj opcji "Listy wyboru", aby pobrać wszystkie. |
|
|
Names
|
names | string |
Wprowadź nazwy zestawów analiz lub list wyboru, które chcesz pobrać. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | integer |
id |
|
nazwa
|
name | string |
nazwa |
|
groupId
|
groupId | integer |
groupId |
|
groupName
|
groupName | string |
groupName |
|
topLevelMenu
|
topLevelMenu | string |
topLevelMenu |
Pobieranie wyników lub danych głównych
Pobieranie wyników (jakości) z zestawów analiz lub danych głównych z list wyboru.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
Poddomena, która ma być używana dla żądania. |
|
Identyfikator zestawu
|
setId | True | integer |
Wprowadź unikatowy identyfikator interesującego Cię zestawu analiz (historycznie znany jako maskid w adresach URL). |
|
Ograniczenie
|
limit | integer |
Określ maksymalną liczbę rekordów, które chcesz otrzymywać, maksymalnie 10 000. |
|
|
Przesunięcie
|
offset | integer |
Wybierz pozycję początkową dla wyników, przydatną do stronicowania danych (domyślnie 0). |
|
|
Sortuj
|
sort | string |
Określ kolejność danych według pola i kierunku, na przykład date:desc dla najnowszego pierwszego. |
|
|
Filter
|
filter | string |
Użyj ciągu sformatowanego w formacie JSON, aby zawęzić żądane dane na podstawie określonych warunków. |
|
|
Pola formularza
|
fields | string |
Rozdzielona przecinkami lista z określonymi punktami danych, które chcesz zwrócić. |
|
|
Dołączanie załączników
|
includeAttachments | boolean |
Oznacz wartość true, jeśli chcesz uwzględnić wszystkie załączniki plików z danymi, w przeciwnym razie pozostaw wartość false. |
|
|
Identyfikator dołączania
|
includeId | boolean |
Ustaw wartość true, jeśli chcesz uzyskać unikatowe numery rekordów systemu dla danych, co ułatwia zarządzanie danymi lub ich odwołanie. |
|
|
Dołącz ostatnią datę modyfikacji
|
includeLastModificationDate | boolean |
Włącz, aby uzyskać datę ostatniej zmiany dla każdego elementu danych, co doskonale nadaje się do śledzenia najnowszych aktualizacji. |
Tworzenie lub aktualizowanie wyników lub danych głównych
Tworzenie lub aktualizowanie wyników dotyczących jakości w zestawach analiz lub danych głównych na listach wyboru.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
Poddomena, która ma być używana dla żądania. |
|
Identyfikator zestawu
|
setId | True | string |
Wprowadź unikatowy identyfikator interesującego Cię zestawu analiz (historycznie znany jako maskid w adresach URL). |
|
Results
|
results | True | string |
Obiekt JSON jako ciąg. |
|
Pole klucza
|
keyField | string |
Znajdź i zmodyfikuj istniejące wyniki na podstawie wartości tego pola. |
|
|
Edytuj tylko
|
editOnly | string |
Użyj (tylko) w połączeniu z polem keyField. |
|
|
Dodaj opcje listy
|
addListOptions | string |
Flaga dodawania nowych opcji do list. |
Tworzenie nowej wersji specyfikacji
Utwórz (a) nowe wersje specyfikacji dla zestawów analiz.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
Poddomena, która ma być używana dla żądania. |
|
Identyfikator zestawu
|
setId | True | string |
Wprowadź unikatowy identyfikator interesującego Cię zestawu analiz (historycznie znany jako maskid w adresach URL). |
|
Specyfikacje
|
specs | True | string |
Obiekt JSON jako ciąg. |
|
Wartość indeksu
|
indexValue | string |
Wartość pola indeksu. |
|
|
Data rozpoczęcia
|
startDateTime | string |
Sformatowany jako rrrr-mm-dd hh:mm:ss lub unix stimestamp. |
|
|
Przyczyna
|
reason | string |
Przyczyna zmiany specyfikacji. |
Zwraca
- response
- boolean
Uzyskiwanie opisowych statystyk dla pól zestawu analiz
Uzyskaj opisowe statystyki dla wybranego pola zestawu analiz liczbowych.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Subdomain
|
subdomain | True | string |
Poddomena, która ma być używana dla żądania. |
|
Identyfikator zestawu
|
setId | True | integer |
Wprowadź unikatowy identyfikator interesującego Cię zestawu analiz (historycznie znany jako maskid w adresach URL). |
|
Pola formularza
|
fields | True | string |
Rozdzielona przecinkami lista z określonymi punktami danych, które chcesz zwrócić. |
|
Ograniczenie
|
limit | integer |
Maksymalna liczba wyników do rozważenia. |
|
|
Filter
|
filter | string |
Użyj ciągu sformatowanego w formacie JSON, aby zawęzić żądane dane na podstawie określonych warunków. |
Definicje
typ logiczny (boolowski)
Jest to podstawowy typ danych "wartość logiczna".