Om onnze API te gebruiken vereist dit voorkennis/ervaring met API's en hoe je ermee moet werken. Dit artikel legt uit wat de Teamtailor API is en hoe je aan de slag kunt.
Wat is de Teamtailor API en wat doet het?
Onze Teamtailor open API volgt de JSON API-specificatie en kan worden gebruikt om informatie te importeren, bewerken, en exporteren van en naar jouw Teamtailor-account. Dit kan van alles zijn, van het ophalen van een lijst met vacatures, een vacature bijwerken, een gebruiker bijwerken - tot het aanmaken van een gebruiker.
Teamtailor biedt twee regio's voor gegevensverwerking en -opslag: EU (Ierland) en US West (Oregon). De API-URL die je gebruikt in je API-calls hangt af van de regio waar jouw account is opgeslagen.
EU-regio: api.teamtailor.com
US West-regio: api.na.teamtailor.com
Aan de slag
Om onze API te kunnen gebruiken, moet er een API-sleutel worden aangemaakt in Instellingen → Integraties → API-sleutels op jouw Teamtailor-account. Let op dat deze pagina alleen toegankelijk is voor gebruikers met de Bedrijfsbeheerder rol.
Hier kun je zowel nieuwe sleutels maken als bestaande verwijderen. Houd er rekening mee dat zodra een API-sleutel is aangemaakt, deze niet bewerkt kan worden, alleen verwijderd.
Om een API-sleutel aan te maken, klik je op + Nieuwe API-sleutel in de rechterbovenhoek.
Er zijn drie verschillende soorten sleutels, met verschillende toestemmingen en reikwijdten. Deze worden allemaal uitgelegd in onze documentatie hier, en zijn als volgt:
Toestemmingen:
Openbaar - toegang tot alle openbare gegevens die beschikbaar zijn op de carrière site
Intern - publieke + interne gegevens (bijvoorbeeld niet-vermelde/interne banen, afdelingen, locaties)
Admin - toegang tot alles in een account
Types:
Lezen - alleen informatie ophalen en ‘lezen’
Schrijven - alleen nieuwe informatie aanmaken
Lezen/Schrijven - kan beide
Voorbeeld van gebruik
Als je bijvoorbeeld een lijst van banen ophaalt via onze API en je wilt alleen een lijst van gepubliceerde banen ophalen, is het goed om een Publieke Lezen sleutel te gebruiken, aangezien dit je toegang geeft tot publieke gegevens op de carrièrepagina, zoals gepubliceerde banen. Als je in plaats daarvan een lijst van alle locaties wilt ophalen, openbaar of niet - moet je een sleutel hebben met ten minste Interne Lezen machtigingen.
Bepaalde gegevens zijn vanwege veiligheidsredenen (bijv. informatie/gegevens van kandidaten) zeer beperkt en kunnen alleen worden geraadpleegd met een sleutel met een Admin scope/machtiging. Als dat het geval is, wordt dit altijd vermeld in de API-documentatie.
Ondersteuningsteam
Met alle beschikbare eindpunten in onze documentatie, zou alles wat nodig is voor een actie in de documentatie moeten worden opgenomen met voorbeelden die getest kunnen worden indien nodig.
Als je algemene vragen hebt over de API-documentatie, voel je vrij om contact op te nemen met onze support via support@teamtailor.com. Maar hou er rekening mee dat we geen ondersteuning bieden voor API-implementatie.
Als er iets niet in de documentatie staat, is het hoogstwaarschijnlijk niet beschikbaar voor implementatie. Aangepaste scripts of verdere integraties kunnen worden gecombineerd met de verzoeken die beschikbaar zijn in onze openbare API-scripts, maar hoe je dat aanpakt, is helemaal aan de klant zelf.