Logo PeekHire
Automatyzacja i deweloperzy

REST API

Odczytuj i zarządzaj kampaniami, zgłoszeniami i użytkownikami programowo.

Interfejs PeekHire REST API pozwala Twojemu oprogramowaniu pracować z danymi rekrutacyjnymi. To standardowy API HTTPS + JSON, więc może z niego korzystać każdy język lub narzędzie, które potrafi wykonywać żądania webowe.

Poznaj każdy endpoint, parametr i schemat w interaktywnej dokumentacji OpenAPI:

Otwórz dokumentację API

Bazowy URL i wersjonowanie

API jest wersjonowany. Wszystkie endpointy znajdują się pod prefiksem /api/v1, aby przyszłe zmiany nie zepsuły Twojej integracji.

Uwierzytelnianie

Uwierzytelniaj każde żądanie za pomocą klucza API wysyłanego jako token bearer:

curl https://your-api-host/api/v1/campaigns \
  -H "Authorization: Bearer YOUR_API_KEY"

Nigdy nie umieszczaj klucza API w kodzie po stronie klienta ani w publicznym repozytorium.

Do czego masz dostęp

API v1 obejmuje podstawowe obiekty rekrutacyjne:

  • Kampanie — wyświetlaj listę ról, na które rekrutujesz, i pobieraj ich szczegóły.
  • Aplikacje — wyświetlaj listę zgłoszeń kandydatów i pobieraj ich szczegóły.
  • Użytkownicy — wyświetlaj listę członków swojego workspace i pobieraj ich szczegóły.

Odpowiedzi są w formacie JSON i zawierają pola, które widzisz w aplikacji, takie jak tytuł i status kampanii albo etap i język aplikacji.

Paginacja i filtrowanie

Endpointy list zwracają wyniki stronami. Użyj parametrów paginacji, aby przechodzić przez duże zestawy wyników, i filtruj tam, gdzie jest to obsługiwane, aby pobierać tylko to, czego potrzebujesz.

Błędy

API używa standardowych kodów statusu HTTP — 2xx oznacza sukces, 4xx problemy z Twoim żądaniem (takie jak brakujący lub nieprawidłowy klucz), a 5xx nieoczekiwane błędy serwera. Odpowiedzi błędów zawierają komunikat opisujący, co poszło nie tak.

Powiązane

Przegląd

Automatyzuj PeekHire za pomocą API, webhooków, narzędzi no-code lub asystenta AI.

Klucze API

Twórz, określaj zakres i rotuj klucze, które uwierzytelniają dostęp do API.