Att använda vårt API kräver förkunskaper/erfarenhet av API: er och hur man arbetar med dessa. Denna artikel förklarar vad Teamtailors API är och hur man kommer igång.
Vad är Teamtailors API och hur används det?
Vårt Teamtailors open API följer JSON API-specifikationen och kan användas för att importera, redigera och exportera information från/till ett Teamtailor-konto. Detta kan vara allt från att hämta en lista över jobb, uppdatera ett jobb, uppdatera en användare - eller till och med skapa en användare.
Teamtailor erbjuder två regioner för databehandling och datalagring: EU (Irland) och västra USA (Oregon). API-URL:en som du använder i dina API-anrop beror på regionen där ditt konto är lagrat.
EU-region: api.teamtailor.com
Västra USA-region: api.na.teamtailor.com
Kom igång
För att kunna använda vårt API måste en API-nyckel genereras i Inställningar → Integrationer → API-nycklar på ditt Teamtailor-konto. Notera att denna sida endast är tillgänglig för användare med företagsadministratörsbehörighet.
Här kan du både skapa nya nycklar och ta bort befintliga. Observera att så snart en API-nyckel har skapats kan den inte redigeras, endast tas bort.
För att skapa en API-nyckel klicka på + Ny API-nyckel i det övre högra hörnet.
Det finns tre olika typer av nycklar, med olika behörigheter och omfattningar. Dessa förklaras i vår dokumentation här, och ser ut enligt följande:
Behörigheter:
Offentlig - tillgång till all offentlig data som finns på karriärsidan
Intern - offentlig + intern data (t. ex. olistade/interna jobb, avdelningar, platser)
Admin - tillgång till allt i ett konto
Omfattning:
Läsa - endast hämta information och 'läsa' det
Skriva - endast skapa ny information
Läsa/Skriva - kan göra båda
Exempel på användningsfall
Om ni till exempel ska göra en hämtning av en lista över jobb via vårt API och du endast vill hämta en lista över publicerade jobb, är det bra att använda en Offentlig Läsa nyckel eftersom det ger dig tillgång till offentlig data på karriärsidan, som publicerade jobb. Om du istället skulle vilja hämta en lista över alla platser, offentliga eller ej - behöver du ha en nyckel med åtminstone Intern Läsa behörigheter.
Viss data är mycket begränsad av säkerhetsskäl (t. ex. kandidatinformation) och kan endast nås med en nyckel med en Admin omfattning/behörighet. Om så är fallet, anges detta alltid i API-dokumentationen.
Support
Med alla tillgängliga slutpunkter i vår dokumentation bör allt som krävs för en åtgärd inkluderas i dokumentationen med exempel som kan testas om så behövs.
Om du har några allmänna frågor om API-dokumentationen, tveka inte att kontakta vår support på support@teamtailor.com men observera att vi inte erbjuder support för API-implementation.
Om något inte listas i dokumentationen är det troligtvis inte tillgängligt för implementering. Anpassade skript eller ytterligare integrationer kan kombineras med de förfrågningar som finns i våra offentliga API-skript, men hur man går tillväga är helt upp till kunden.