Pobieranie danych dot. użytkowników

W niniejszym artykule odkryjesz, jak pobierać dane użytkowników w aplikacji Gamfi przy użyciu API.

Pobieranie danych użytkowników jest możliwe na trzy sposoby, za pomocą:

  • ID
  • e-mail
  • numeru telelefonu

ID

Aby pobrać dane użytkownika używając jego ID skorzystaj z metody i endpointa:

GET + /api/app_api_admin.php/v2/workflows/integration/user/{ID}

Przykładowy cURL:

curl --location 'https://{app_name}.gamfi.io/api/app_api_admin.php/v2/workflows/integration/user/2' \
--header 'X-Samus-Authorization-Api-Key: {apiKey}' \
--header 'X-Samus-Authorization-Api-Secret: {apiSecret}'

W miejscu:

  • {app_name} - wstaw nazwę swojej aplikacji
  • {ID} - wstaw ID użytkownika z aplikacji Gamfi
  • {apiKey} - wstaw klucz API
  • {apiSecret} - wstaw sekret API

E-mail

Aby pobrać dane użytkownika używając jego e-mail skorzystaj z metody i endpointa:

GET + /api/app_api_admin.php/v2/workflows/integration/user/email/{email}

Przykładowy cURL:

curl --location 'https://{app_name}.gamfi.io/api/app_api_admin.php/v2/workflows/integration/user/email/john.doe@gamfi.com' \
--header 'X-Samus-Authorization-Api-Key: {apiKey}' \
--header 'X-Samus-Authorization-Api-Secret: {apiSecret}'

W miejscu:

  • {app_name} - wstaw nazwę swojej aplikacji
  • {email} - wstaw e-mail użytkownika z aplikacji Gamfi
  • {apiKey} - wstaw klucz API
  • {apiSecret} - wstaw sekret API

Numer telefonu

Aby pobrać dane użytkownika używając jego numeru telefonu skorzystaj z metody i endpointa:

GET + /api/app_api_admin.php/v2/workflows/integration/user/phone/{phone_number}

Przykładowy cURL:

curl --location 'https://{app_name}.gamfi.io/api/app_api_admin.php/v2/workflows/integration/user/phone/123456789' \
--header 'X-Samus-Authorization-Api-Key: {apiKey}' \
--header 'X-Samus-Authorization-Api-Secret: {apiSecret}'

W miejscu:

  • {app_name} - wstaw nazwę swojej aplikacji
  • {phone_number} - wstaw numer telefonu użytkownika z aplikacji Gamfi
  • {apiKey} - wstaw klucz API
  • {apiSecret} - wstaw sekret API

W przypadku prawidłowej odpowiedzi (200) otrzymasz potwierdzenie:

{
    "id": 2,
    "forename": "Administrator",
    "surname": "Gamfi",
    "avatar": null,
    "email": "admin@gamfi.pl",
    "phone": null,
    "locations": [],
    "categories": [],
    "custom_fields": []
}