Zarządzanie procesami i workflowami
      Wróć na stronę główną
      1. Baza wiedzy
      2. Gamfi API Docs
      3. Zarządzanie procesami i workflowami

      Startowanie procesów

      W niniejszym artykule odkryjesz, jak uruchamiać procesy na bazie workflowów w aplikacji Gamfi przy użyciu API.

      Aby uruchomić proces w aplikacji Gamfi skorzystaj z metody i endpointa:

      POST + /api/app_api_admin.php/v2/workflows/integration/process

      Przykładowy cURL:

      curl --location 'https://{app_name}.gamfi.io/api/app_api_admin.php/v2/workflows/integration/process' \
      --header 'X-Samus-Authorization-Api-Key: {apiKey} ' \
      --header 'X-Samus-Authorization-Api-Secret: {apiSecret} ' \
      --header 'Content-Type: application/json' \
      --data-raw '{
        "employee_email": "john.doe@gamfi.com",
        "workflow_id": "3f9a81c3-132c-4660-b459-2226805b1d80",
        "key_date": "2024-01-01"
      }'

      W miejscu:

      • {app_name} - wstaw nazwę swojej aplikacji
      • {apiKey} - wstaw klucz API
      • {apiSecret} - wstaw sekret API

      Struktura requestu powinna zawierać następujące dane:

      • "employee_email": adres e-mail użytkownika, dla którego uruchamiasz proces
      • "workflow_id": ID workflow, na bazie którego chcesz uruchomić proces (zobacz więcej: Pobieranie listy workflowów)
      • "key_date": kluczowa data w procesie w formacie RRRR-MM-DD

      Dodatkowo w ramach requestu możesz przekazać więcej dancych, np.:

      • "employee_forename": imię użytkownika
      • "employee_surname": nazwisko użytkownika
      • "employee_phone": numer telefonu użytkownika
      • "employee_company": ID firmy, do której ma być przypisany użytkownik (zobacz więcej: Pobieranie listy firm)

      A także (opcjonalnie) wiele innych danych, takich jak:

      • dodatkowe role biorące udział w procesie (np. Manager, HRBP, IT, itd.) - w Gamfi znane jako "Role"
      • kategorie pracownika, które służą do personalizacji akcji w procesie (np. region, departament, oddział) - w Gamfi znane jako "Kategorie"
      • customowe wartości (np. numer SAP, stanowisko pracy) - w Gamfi znane jako "Pola niestandardowe"

      Przykładowy cURL:

      curl --location 'https://{app_name}.gamfi.io/api/app_api_admin.php/v2/workflows/integration/process' \
      --header 'X-Samus-Authorization-Api-Key: {apiKey} ' \
      --header 'X-Samus-Authorization-Api-Secret: {apiSecret} ' \
      --header 'Content-Type: application/json' \
      --data-raw '{
        "employee_forename": "John",
        "employee_surname": "Doe",
        "employee_email": "john.doe@gamfi.com",
        "employee_phone": "+48123123123",
        "roles": [
         {
           "role_id": "22d864fd-de63-4c25-be0a-b42a94bfeb6a",
           "user_forename": "Jane",
           "user_surname": "Doe",
           "user_email": "jane.doe@gamfi.com",
           "user_phone": "+48123123123"
         }
      ],
        "employee_categories": [
         {
           "category_id": "094f1129-6af3-4687-aa86-acbc7bb97ef7",
           "options": [
            {
             "id": "b85059a4-3691-43cc-bd46-170e1e7eaa22"
            }
           ]
         }
      ],
        "employee_custom_fields": [
         {
           "custom_field_id": "781bd8db-e310-4fab-b68a-cead1b987918",
           "value": "string"
         }
      ]
      }'

      W przypadku prawidłowej odpowiedzi otrzymasz status (200).

      ⚠️ W przypadku, gdy użytkownik (pracownik / manager lub inna rola) nie posiada konta w Gamfi, rozpoczęcie procesu spowoduje utworzenie nowego konta, korzystając z podanych danych.