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)
      • "manager_forename": imię managera
      • "manager_surname": nazwisko managera
      • "manager_email": adres e-mail managera
      • "manager_phone": numer telefonu managera

      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",
        "manager_forename": "Jane",
        "manager_surname": "Doe",
        "manager_email": "jane.doe@gamfi.com",
        "manager_phone": "48123123124",
        "workflow_id": "3f9a81c3-132c-4660-b459-2226805b1d80",
        "key_date": "2024-01-01"
      }'

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

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