Do automatycznego startowania procesów w Gamfi należy użyć interfejsu REST API oraz metody POST. Ciało requestu powinno zawierać dane dotyczące pracownika, managera oraz workflow i kluczowej daty.
Poniższe endpoint realizuje dwie funkcje jednocześnie: zakładanie kont pracowników oraz uruchamianie procesów.
Endpoint:/api/app_api_admin.php/v2/workflows/integration/process
https://{{App Domain}}/api/app_api_admin.php/v2/workflows/integration/process
Metoda:
POST
Headers:
X-Samus-Authorization-Api-Key: {{api key}}
X-Samus-Authorization-Api-Secret: {{api secret}}
Content-Type: application/json
Ciało żądania:
"employee_forename": "Jan",
"employee_surname": "Kowalski",
"employee_email": "jan.kowalski@gamfi.pl",
"employee_phone": "0048123456789",
"manager_forename": "Paweł",
"manager_surname": "Nowak",
"manager_email": "pawel.nowak@gamfi.pl",
"manager_phone": "0048123456789",
"workflow_id": "d5de6be3-edcf-495b-951b-ae81ff414c95",
"key_date": "2023-01-01"
Dane przekazywane do Gamfi:
employee_forename - imię pracownika
employee_surname - nazwisko pracownika
employee_email - adres e-mail pracownika
employee_phone - numer telefonu pracownika
manager_forename - imię managera
manager_surname - nazwisko managera
manager_email - adres e-mail managera
manager_phone - numer telefonu managera
workflow_id - unikatowy numer ID workflowa (skąd wziąć ID workflow?)
key_date - kluczowa data dla procesu w formacie RRRR-MM-DD
⚠️ Nadmiarowe dane w body są ignorowane. Aby proces wystartował ciało request musi posiadać: EmployeeEmail, ManagerEmail, WorkflowID oraz KeyDate.
Przykładowy cURL:
cURL --location --http1.1 --request POST 'https://{{App Domain}}/api/app_api_admin.php/v2/workflows/integration/process' \
--header 'X-Samus-Authorization-Api-Key: 0ebrInCQsoP2BEDOvZHfvT4wFprhkzTlj03pDU2UjZ003l6Ni8I_2O_WsZiDRAL' \
--header 'X-Samus-Authorization-Api-Secret: ZwW3Z0wYIBfvfvPvYUwJaF21HEIPL8e' \
--header 'Content-Type: application/json' \
--data-raw '{
"employee_forename": "Jan",
"employee_surname": "Kowalski",
"employee_email": "jan.kowalski@gamfi.pl",
"employee_phone": "0048123456789",
"manager_forename": "Paweł",
"manager_surname": "Nowak",
"manager_email": "pawel.nowak@gamfi.pl",
"manager_phone": "0048123456789",
"workflow_id": "d5de6be3-edcf-495b-951b-ae81ff414c95",
"key_date": "2023-01-01"
}'Masz więcej pytań? Sprawdź odpowiedzi w Gamfi API: FAQ lub napisz na chacie.