Gamfi API Docs
      Wróć na stronę główną
      1. Baza wiedzy
      2. Gamfi API Docs

      🚀 Szybki start

      Ten artykuł zawiera wyczerpujące informacje na temat funkcji, punktów końcowych i sposobu korzystania z naszego interfejsu API, umożliwiając łatwą i skuteczną integrację z usługą.

      Szybki start

      Aby rozpocząć korzystanie z Gamfi API, należy przejść przez prosty proces inicjalizacji:
      1. Autoryzacja: Przed rozpoczęciem korzystania z interfejsu API należy zapoznać się z sekcją dotyczącą autoryzacji, aby prawidłowo uwierzytelniać żądania.
      2. Rejestracja i uzyskanie klucza API: Zaloguj się do naszej aplikacji i wygeneruj klucz API, aby uzyskać dostęp do naszych usług.
      3. Przykłady użycia: W sekcji "Przykłady użycia" znajdziesz przykładowe żądania, aby szybko rozpocząć korzystanie z naszego API.

      Obsługiwane metody HTTP

      Gamfi API obsługuje różne metody HTTP, takie jak GET, POST, PUT, DELETE. Każda metoda jest przeznaczona dla określonych funkcji w usłudze.

      1. Autoryzacja

      Aby korzystać z API Gamfi, należy posiadać aplikację oraz zarejestrowane i aktywne konto użytkownika z uprawnieniami administratora. Zaloguj się do Gamfi, aby uzyskać token (Bearer), którego użyjesz do wygenerowania klucza API.

      Przykładowy cURL:

      curl --location 'https://{app_name}.gamfi.io/api/app_api_admin.php/v1/auth/email/1/login' \
      --header 'Content-Type: application/json' \
      --data-raw '{
          "email": "{john.doe@gamfi.com}",
          "password": "{password}"
      }'

      W miejscu:

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

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

      {
          "code": 200,
          "response": "88a4d71d-4e30-4bf7-8b74-18ed8ca2614d"
      }
      • response - jest tokenem autoryzacyjnym (Bearer), który zostanie użyty w następnym kroku.

      2. Rejestracja i uzyskanie klucza API

      Po uzyskaniu tokena (Bearer) można wygenerować klucz API, który jest wymagany do korzystania z naszej usługi za pośrednictwem API. Wygeneruj nowy klucz.

      Przykładowy cURL:

      curl --location --request PUT 'https://{app_name}.gamfi.io/api/app_api_admin.php/v1/api-access/user/' \
      --header 'X-Samus-Authorization: Bearer {token}'

      W miejscu:

      • {app_name} - wstaw nazwę swojej aplikacji
      • {token} - wstaw token otrzymany w pierwszym kroku (Bearer)

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

      {
          "code": 200,
          "response": {
              "apiKey": "e7iuHI7uhNdnwGlkPjVw_QIAVGekKKOpxqZD8jA7BRHLBVghnPMOSwQ7QwgLc0wI",
              "apiSecret": "REvVqetagK1XnplyVnHF4Aw6BH4DvHfU",
              "lastUsed": null
          }
      }
      • apiKey - to jest twój klucz API
      • apiSecret - to jest twój sekret API

      apiKey i apiSecret to dwa kluczowe elementy wykorzystywane w procesie uwierzytelniania podczas korzystania z Gamfi API. Oba służą do zapewnienia bezpiecznego dostępu do zasobów i funkcji udostępnianych przez nasze API. 

      ⚠️ Nie należy przekazywać kluczy API ani sekretów API stronom trzecim, które nie są zaufanymi i autoryzowanymi użytkownikami.

      Nie umieszczaj kluczy API ani sekretów API w kodzie źródłowym, plikach ani innych publicznie dostępnych miejscach. Informacje te należy przechowywać w bezpiecznym i poufnym środowisku.

      3. Przykłady użycia

      Po wygenerowaniu apiKey i apiSecret można skorzystać z gotowych punktów końcowych, które odpowiadają za wykonanie poszczególnych operacji w aplikacji Gamfi. Poznaj możliwości naszego API:

      Zarządzanie użytkownikami

      Zarządzanie procesami i workflowami

      Pobieranie raportów