REST API

The PeekHire REST API umožňuje vašemu vlastnímu softwaru pracovat s náborovými daty. Jde o standardní HTTPS + JSON API, takže ho může používat jakýkoli jazyk nebo nástroj, který umí posílat webové požadavky.

Projděte si všechny endpointy, parametry a schémata v interaktivní OpenAPI referenci:

Základní URL a verzování

API je verzované. Všechny endpointy jsou pod prefixem /api/v1, aby budoucí změny nenarušily vaši integraci.

Ověřování

Každý požadavek ověřte pomocí API klíče odeslaného jako bearer token:

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

API klíč nikdy nevkládejte do kódu na straně klienta ani do veřejného repozitáře.

K čemu máte přístup

API v1 pokrývá hlavní náborové objekty:

• Kampaně — zobrazujte seznam a detail pozic, na které nabíráte.
• Přihlášky — zobrazujte seznam a detail přihlášek kandidátů.
• Uživatelé — zobrazujte seznam a detail členů vašeho pracovního prostoru.

Odpovědi jsou ve formátu JSON a obsahují pole, která vidíte v aplikaci, například název a stav kampaně nebo fázi a jazyk přihlášky.

Stránkování a filtrování

Endpointy se seznamy vracejí výsledky po stránkách. Pomocí parametrů stránkování můžete procházet rozsáhlé sady výsledků a tam, kde je to podporované, filtrovat jen to, co potřebujete.

Chyby

API používá standardní stavové kódy HTTP — 2xx pro úspěch, 4xx pro problémy s vaším požadavkem (například chybějící nebo neplatný klíč) a 5xx pro neočekávané chyby serveru. Chybové odpovědi obsahují zprávu popisující, co se pokazilo.

Související

• API klíče
• Webhooky pro push oznámení místo pravidelného dotazování