Public API
- Sledujte změny v API
Při změnách našeho API vás upozorněníme e-mailem.
- Autorizace
Autorizace probíhá pomocí Bearer tokenu, který musí být posílán v hlavičce každého requestu na API endpointy. Každá firma obdrží unikátní token.
Authorization: Bearer <token>
- Seznam nabídek
Endpoint vrací seznam aktivních nabídek firmy
Endpoint URL
GEThttps://api.startupjobs.cz/company/offers
Query Parameters
none
Request example
https://api.startupjobs.cz/company/offers
Response
200 OK
Headers
Content-type: application/json
Body
[ { "id": "9629f28d-78b5-4194-90f9-996cd6cf2aa9", "links": [ { "url": "https://www.startupjobs.cz/nabidka/1234", "lang": "cs" }, { "url": "https://www.startupjobs.cz/en/job/1234", "lang": "en" } ], "names": [ { "name": "StartupJobs PHP žralok", "lang": "cs" }, { "name": "StartupJobs PHP shark", "lang": "en" } ], "internal_name": "PHP programátor", "descriptions": [ { "description": "<p>Pojď pracovat s námi! StartupJobs</p>", "lang": "cs" }, { "description": "<p>Come work with us! StartupJobs</p>", "lang": "en" } ], "locations": [ "Praha, Česko" ], "shifts": [ { "name": "FULL_TIME", "hours": 160 }, { "name": "PART_TIME", "hours": 80 } ], "collaborations": [ { "id": 1, "collaboration": "external" }, { "id": 2, "collaboration": "remote" }, { "id": 3, "collaboration": "internship" } ], "seniorities": [ { "id": 1, "seniority": "junior" } ], "areas": [ { "id": 1, "area": "Vývoj" }, { "id": 2, "area": "Back-End" }, { "id": 4, "area": "PHP" } ], "salary": { "min": 50000, "max": 80000, "measure": "monthly", "currency": "CZK" }, "benefits": [ { "id": 1, "benefit": "13. a 14. plat" }, { "id": 6, "benefit": "Čas na inovace" }, { "id": 7, "benefit": "Čas na vlastní projekt" } ], "created_at": "2020-07-08T13:46:45", "updated_at": "2020-07-08T13:59:47", "valid_until": "2020-08-07T13:47:24" } ]
- Seznam kandidátů
Endpoint vrací seznam všech kandidátů firmy
Endpoint URL
GEThttps://api.startupjobs.cz/company/applications
Query Parameters
Name Description offeruuid of the offer created_at.gtreturns candidates created after given date created_at.ltreturns candidates created before given date Request example
https://api.startupjobs.cz/company/applications?offer=1e8c1d7b-673a-42b6-9da9-5eeb2a8ce308&created_at.gt=2020-04-01&createad_at.lt=2020-05-01
Response
200 OK
Headers
Content-type: application/json
Body
[ { "id": "3e51e86d-9562-4611-a8a4-97412569f446", "name": "Pan Žralok", "created_at": "2020-07-08T13:56:43", "offer": { "id": "9629f28d-78b5-4194-90f9-996cd6cf2aa9", "names": [ { "name": "StartupJobs PHP zralok", "lang": "cs" }, { "name": "StartupJobs PHP shark", "lang": "en" } ], "created_at": "2020-07-08T13:46:45" } } ]
- Detail kandidáta
Endpoint vrací detailní informace o kandidátovi
Endpoint URL
GEThttps://api.startupjobs.cz/company/applications/{candidate uuid}Query Parameters
none
Request example
https://api.startupjobs.cz/company/applications/3e51e86d-9562-4611-a8a4-97412569f446
Response
200 OK
Headers
Content-type: application/json
Body
{ "id": "5bf84a69-3a5c-4ddb-8cea-ae111bd262c5", "name": "Pan Žralok", "email": "zralok@startupjobs.cz", "phone": "123 456 789", "linkedin": { "url": "https://www.linkedin.com/panzralok" }, "text": "Umím skvěle programovat v PHP!", "attachments": [ { "url": "https://www.startupjobs.cz/uploads/panzralok.png" } ], "notes": null, "status": "new", "offer": { "id": "9629f28d-78b5-4194-90f9-996cd6cf2aa9", "name": [ { "name": "StartupJobs PHP žralok", "lang": "cs" }, { "name": "StartupJobs PHP shark", "lang": "en" } ], "internal_position_name": "PHP programátor" }, "created_at": "2020-07-08T13:59:47" }
- Přihlášení k odběru nových nabídek
Endpoint umožňuje zaregistrovat e-maily uživatelů, kteří obdrží upozornění, jakmile firma přidá novou nabídku.
Máte zájem o využití tohoto endpointu? Kontaktujte prosím support@startupjobs.cz.
Webhooks
- Jak webhook nastavit?
Při přidání/úpravě nabídky v sekci Další možnosti můžete zadat URL adresu (webhook), na kterou vám budeme zasílat informace o zájemcích ihned po jejich přihlášení.
Webhook musí vracet HTTP response code 200, 201, 202, 204 nebo 422, jinak webhook automaticky odmažeme.
- JSON payload
Informace o zájemci posíláme ve formátu JSON.
{ "date": "2017-09-11T18:19:15+02:00", "candidateID": 12345, "candidateUUID": "550e8400-e29b-41d4-a716-446655440000", "offerID": 1234, "name": "Pan Žralok", "position": "Vývojář webhooků", "why": "<p>Chci se stát vývojářem webhooků na StartupJobs.cz, protože mě to baví!</p>", "phone": "+420 725 875 752", "email": "dev@startupjobs.cz", "details": "https://www.startupjobs.cz/admin/company/zajemce/32437/pan-zralok?oid=1234", "linkedin": "https://linkedin.com/pan-zralok", "internalPositionName": "JOB1", "files": [ "https://www.startupjobs.cz/download/file.pdf" ], "gdpr_accepted": true } - Testovací payload
Při nastavení webhooku (přidání/úprava nabídky sekce Další možnosti) můžete poslat testovací request (simulace přihlášení kandidáta). Payload testovacího requestu obsahuje navíc hodnotu "test":true.
{ "date": "2017-09-11T18:19:15+02:00", "candidateID": 12345, "offerID": 1234, "name": "Mr. Shark", "position": "Webhook developer", "why": "<p>Hello from StartupJobs. This is not a real candidate, just testing your webhook.</p>", "phone": "+420 725 875 752", "email": "dev@startupjobs.cz", "details": "https://www.startupjobs.cz/", "linkedin": "https://linkedin.com/", "internalPositionName": "JOB1", "files": [ "https://www.startupjobs.cz/favicon.ico" ], "gdpr_accepted": true, "test": true }V případě dotazů nás neváhejte kontaktovat na support@startupjobs.cz.
