Introductie
De OTYS Web API verbindt je website direct met OTYS Go!. De Web API is onze oplossing voor het solliciteren door kandidaten op een bestaande website. Als je nog geen website hebt maar dat wel wil en geen behoefte hebt om een externe partij te zoeken, is het misschien interessant om te weten dat wij bij OTYS onze eigen sitebouwer aanbieden. Deze sitebouwer is ook gebaseerd op de Web API en bied dus dezelfde mogelijkheden. Op deze manier krijg je alle voordelen van direct aansluiten op OTYS Go! Zonder de complexe web ontwikkeling en zonder het inhuren van een derde partij.
Mogelijkheden en documentatie
De Web API is de verbeterde versie (en de opvolger) van onze vorige API, die we de Job API noemden. De eerste versie bood alleen vacatures aan, maar de nieuwe Web API biedt nu ook volledige applicatieverwerking. Voor de volledige lijst met opties kun je onze API-verbinding doorlezen. Dit kan hier. Je kunt ook onze uitgebreidere documentatie bekijken in ReDoc. Als je liever onze volledige documentatie in Postman wilt bekijken en tussen scripttalen kunt wisselen, kun je dit hier vinden.
Om je een algemeen overzicht te geven van wat de Web API kan technische documentatie te hoeven doornemen hebben we hieronder een samengevatte lijst toegevoegd.
Vacatures tonen
Details van van de vacature, inclusief de eigenaar van de vacature, hun gegevens, alle teksten, afbeeldingen en meer kunnen ophalen
Het gebruik filters voor vacatures op basis van je matchcriteria
Standaard applicaties verwerken
Open applicaties verwerken
Begin direct een procedure in OTYS Go! Wanneer een kandidaat zich aanmeldt
Welke weboplossing heb ik nodig?
Bij OTYS bieden we drie interne weboplossingen die aan al uw behoeften voldoen. Deze oplossingen hebben hun eigen gedetailleerde artikelen, maar we vatten ze hier voor je samen. We bieden ook weboplossingen aan via partners.
OTYS WebAPI
Je hebt een bestaande website van een externe partij en je wilt de wervingsfunctionaliteit van Go! implementeren op je website. Je hebt de controle over het ontwerp van je site en je workflow. Dit betekent dat de merkidentiteit van je site blijft zoals die is. Deze oplossing is zeer efficiënt en verwerkt applicaties en procedures automatisch na enige installatie. Het is ook zeer schaalbaar, waardoor je meerdere merken of websites kunt verbinden met OTYS Go!.
OTYS Site Builder
Als je nog geen website hebt maar er wel een wilt aanschaffen, en je wilt dat het geïntegreerd wordt met OTYS, ga dan! Dan is de suite builder de beste optie voor jou. Het is onze eigen interne tool om websites vanaf nul te maken die direct naar je Go! linken. milieu. Het vereist weinig technische kennis en kan allemaal worden gedaan door ons uitgebreide artikel te volgen, dat je hier kunt vinden.
WordPress-plugin
Als je een WordPress-site hebt, wil je waarschijnlijk onze WordPress-plugin gebruiken. Dit haalt ook een groot deel van het technische werk en de knowhow weg, door bestaande sjablonen te gebruiken om te koppelen aan OTYS Go!. Deze oplossing vereist dat je al een WordPress-site hebt, en het kan zijn dat er nog wat front-end ontwikkeling nodig is.
Hoe krijg ik een Web API key?
Voor meer informatie over de Web API of als je van ons een API key wil ontvangen vragen we je een ticket aan te maken met je verzoek, of contact te leggen met je Customer Success Manager. Vanaf daar pakken wij het verder op.
Zodra de API key is afgeleverd is de configuratie aan onze kant klaar en kan de (externe) eigen web bouwer beginnen met de integratie.
Wij verzoeken je wel om ons uiterlijk 2 weken van te voren te laten weten wanneer je live wil met de integratie. Zo kunnen wij er voor zorgen dat alles aan de OTYS kant soepel verloopt.
Technische checklist waar rekening mee te houden
Caching
Houd er rekening mee dat het cachen van sommige data van belang is. Wanneer je bijv. een API key ophaalt en deze inwisselt voor een JSON Web Token is het belangrijk dat je deze web token opslaat en deze pas weer opnieuw ophaalt zodra de ‘expires_at’ datum is verstreken. Lees het onderdeel ‘Webhooks’ hoe je deze cache up to date houd.
Webhooks
Wanneer je bijv. vacature (lijst)weergaves cached, is het belangrijk dat deze cache automatisch ververst word om te garanderen dat de informatie op de die op de website getoond word up-to-date is en de recruiter niet zelf handmatig de cache hoeft te legen. Hiervoor hebben wij webhooks gemaakt. Webhooks geven een seintje aan jouw server zodra er informatie gewijzigd is, zodat jij de informatie aan jou kant kan updaten. Hoe webhooks werken en hoe je deze kan registeren kun je lezen in onze swagger documentatie.
Zie swagger docs:
Vacature URL’s & Identifiers
OTYS maakt gebruik van vacature slugs, zodat websites mooie SEO vriendelijke URLS kunnen opbouwen voor vacatures op websites. Het is van belang dat wanneer je een website koppeling bouwt met de Web API, dat je jouw ‘identifiers’ baseert op de slugs van OTYS. Wanneer je vacatures ophaalt via de Web API zul je de desbetreffende slug terug krijgen per vacature, dit is de identifier die jij moet gebruiken in de url wanneer je vacatures toont. Wanneer je een meertalige website bouwt kunnen de slugs per taal verschillen, ook deze krijg je op een logische manier terug vanuit de Web API bij het ophalen van de vacatures.
Naast het gebruiken van slugs, is het van belang dat OTYS weet wat de structuur is van de vacature URL van jouw website. Dit is van belang zodat OTYS deze URL’s kan communiceren naar bijvoorbeeld derde partijen, zoals job boards en vanuit OTYS kan linken naar vacatures op jouw website.
Zie swagger docs:
Domein & URL structuur
Het is belangrijk dat OTYS weet op welk domein jouw website word gehost en wat de url is van de vacature overzicht, vacature detail en preview pagina. Het domein en de structuur van deze pagina’s kan je eenvoudig doorgeven aan OTYS via de Web API. In de swagger documentatie word hierna gerefereerd als “external” url’s.
Zie swagger docs: