FAQ Web API

Yes, it’s possible to send your HTTP requests to the API with a “Accept-Language” header. When you for example pass a value of “en“ you will retrieve vacancies and their content in the “English” language.

The contents of those default mails are based upon OTYS Go! Documents, which can contain mergefields.
Upon activation of the Web API documents are created in the “Documents Module” in OTYS Go! Key or Super - users are able to edit those documents. The following documents are created with the category “Web API” and used by default:
- Application confirmation to new candidate
- Application confirmation to known candidate
- Application confirmation code to candidate
- Application notification to vacancy owner
- Open application confirmation to new candidate
- Open application confirmation to consultant

In the client settings of OTYS Go! you can (as a key/super-user) search for website setting: GE370 “WebAPI - Standard e-mails configuration“ and configure it per website.

Some of our clients have multiple “Websites” or “Brands” they can publish vacancies on.
It’s possible to send your HTTP requests to the API with a “Website-ID” header. When you for example pass a value of “1” it will return data in the context of the website with id “1”

The Swagger Docs are located here: https://webapi.otys.app/api

When you have received a API Key from OTYS, it’s possible to try out the API on the Swagger documentation. Follow the steps below:

1. Open the “/api/auth” method, and click on “Try it out”
   

2. Replace the placeholder “PASTE_YOUR_API_KEY_HERE“ with your API Key
   

3. Now click “Execute”
   

4. If everything went well, you’ll see that the response contains an “accessToken“, copy this

5. Now on top of the documentation page, click “Authorize”

6. An pop-up will open, past the “accessToken” of step 4 in the “Value” input, and click “Authorize”
   

7. Now you are able to try out the different requests, for example, retrieving a list of possible Websites of this client (the one you just authorized as)
   
   

Using the “Website” entity in the API, you are able to set a WebHook endpoint, this way we can notify you when data in OTYS Go! is updated, this is useful for when you have caching implemented on your website.
You can “subscribe” to those updates, by giving us the URL you would like to receive updates on in the “Website” entity, The property is called: “webhookUrl“.
If all setup correctly, we will simply send you a “nudge” whenever a relevant entity is mutated, created or deleted. Check the Swagger docs for more information, and different types of “nudges”

When the OTYS Go! slug system is enabled, you will be able to tell OTYS Go! how your vacancy (external) URL is set up. You can tell us this by Patching the website entity in the format below. (Please also check the Swagger docs)

{
  "externalApplyUrlFormat": "/vacancies/{{slug}}/apply",
  "externalVacancyDetailUrlFormat": "/vacancies/{{slug}}",
  "externalVacancyPreviewUrlFormat": "/vacancies/{{slug}}/preview",
  "externalUrl": "https://www.your-domain.com"
}

The {{slug}} part is defined in OTYS Go!