Uwierzytelnianie

Dostęp do Partner API wymaga uwierzytelniania za pomocą tajnych kluczy API. Klucze można generować i nimi zarządzać w Partner Console.

Klucze API są Twoimi poświadczeniami dostępu do zasobów partnera. Każdy klucz ma ograniczony dostęp do danych określonej organizacji i w razie potrzeby można go natychmiast dezaktywować.

Obchodź się z kluczami API ostrożnie — zapewniają one pełny dostęp do Twojego konta! Nigdy nie ujawniaj tych kluczy w publicznych repozytoriach, aplikacjach po stronie klienta ani w żadnym miejscu, w którym mogłyby zostać przejęte.

Uwierzytelniaj żądania za pomocą HTTP Basic Auth, przekazując klucz API jako nazwę użytkownika. Pole hasła pozostaw puste.

API akceptuje wyłącznie bezpieczne połączenia HTTPS. Zwykłe żądania HTTP są odrzucane, podobnie jak wszystkie żądania bez prawidłowych poświadczeń uwierzytelniających.

Przykładowe żądanie

curl https://partner-api.performancehub.co/partner/v1/organisations \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# The colon prevents curl from asking for a password.

Weryfikacja tajnego klucza

curl https://partner-api.performancehub.co/partner/v1/auth/ping \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# Returns { "message": "You are successfully authorised as <PartnerName>" }