Ogólny interfejs API został zaprojektowany tak, aby umożliwić pobieranie, wyświetlanie, aktualizowanie, tworzenie i usuwanie wpisów danych w systemie. Można go wykorzystać do automatyzacji procesów, takich jak zarządzanie dostawcami lub tworzenie projektów.

Modele i działania

Każdy typ danych (np. cmp, projekt, dostawca itp.) nazywany jest modelem, a każdy model udostępnia kilka akcji (get/list/update/…). Możesz użyć wywołania info , aby otrzymać specyfikację OpenAPI wszystkich modeli i akcji:

https://[API-Endpoint]/info

Należy pamiętać, że nieautoryzowane wywołania modelu info spowodują wygenerowanie specyfikacji OpenAPI dla działań nieautoryzowanych. Aby uzyskać wszystkie modele i działania dostępne dla Twojego konta, najpierw się uwierzytelnij.

Struktura adresów URL

Wezwania do działania mają następującą strukturę:

https://[API-Endpoint]/model/[MODELNAME]/[ACTIONNAME]

Przykład:

https://[API-Endpoint]/model/CMP/list

Oprócz wywołań modelowych istnieją wywołania do uwierzytelniania oraz specyfikacji OpenAPI:

https://[API-Endpoint]/auth/[AUTH-ACTION]
https://[API-Endpoint]/info

Ogólna struktura komunikatu

Komunikacja odbywa się poprzez wysyłanie danych JSON w obie strony. Aby rozpocząć działanie, wyślij żądanie POST z następującymi danymi JSON w treści HTTP:

{
  "accessType": 1,         // Access type (may be required for authentication calls)
  "lang":       1|2|3|..., // Language (optional)  
  "kmd":        "...",     // Authentication token (optional/required depending on context)  
  "key":        "..."      // Your API-Key (optional/required depending on context)
  // other fields might be required depending on context
}

Zawartość danych JSON może się różnić w zależności od wykonywanej czynności. Dlatego prosimy o zapoznanie się z sekcją „Czynności” tutaj.

W zależności od wdrożenia projektu key może być wymagany do wykonania niektórych czynności (np. utworzenia nowego konta). Skontaktuj się ze swoim opiekunem klienta, aby otrzymać swój klucz.

API odpowie treścią JSON sformatowaną w następujący sposób:

{
  "status":     "...",  // Status: Success|Error 
  "statuscode": 0..999, // Status code
  "msg":        "...",  // Human readable status message
  "model":      "...",  // Context dependend. May return model type to be displayed or null
  "action":     "...",  // Action performed
  "data":        ...    // Type and content is depended on context  
}

Kody błędów

API będzie używać następujących kodów błędów w celu sygnalizowania problemów. Kod błędu jest wysyłany poprzez statuscode w odpowiedzi.

Rodzaje dostępu

W zależności od struktury API istnieją różne typy dostępu (pole JSON „accessType”). Skontaktuj się ze swoim opiekunem klienta, aby otrzymać identyfikator typu dostępu, z którego możesz korzystać.

Modele

W zależności od projektu i Twoich uprawnień możesz zobaczyć różne modele (struktury danych, które mają być pobierane z bazy danych lub do niej wstawiane). Proszę kliknąć przycisk rights , aby otrzymać listę modeli i akcji.