MuchSkills API och API-åtkomst

Så fungerar det

MuchSkills API använder OAuth 2.0 med flödet client credentials. Varje API-klient har eget Client ID, egen Client Secret och egna scopes. På så sätt kan varje integration få en egen klient, och du kan återkalla en av dem utan att de andra påverkas. Basadressen är https://app.muchskills.com.

Innan du börjar

• I MuchSkills: rollen Owner eller Admin för att kunna skapa klienter.
• En utvecklare eller ett verktyg som kan göra HTTPS-anrop, till exempel egen kod, en integrationsplattform eller Power Query.
• Välj scope. Read för rapportering och exporter. Write bara om integrationen ändrar data.
• En säker plats för hemligheten. En lösenordshanterare eller ert valv för hemligheter. MuchSkills visar hemligheten bara en gång.
• API-referensen. Den finns på app.muchskills.com/api/docs och öppnas när du har loggat in i MuchSkills. Utvecklare utan inloggning kan be supporten om åtkomst.

Steg

Inne i MuchSkills

1. Öppna API Access. Gå till Team/Org › Settings › API Access. Du kan också klicka på Go to API Access på sidan Integrations.
2. Skapa en klient. Klicka på New Client. I Create API client anger du ett Name som är lätt att känna igen, till exempel Rapportpipeline. Under Scopes kryssar du i Read, och Write bara om det behövs. Klicka sedan på Create Client.

Team/Org › Settings › API Access › New Client

3. Kopiera inloggningsuppgifterna. Fönstret Copy your credentials visar Client ID och Client Secret. Kopiera båda till en säker plats innan du klickar på Done. Client Secret visas bara en gång.

Create API client: 1 Name, 2 Read eller Write, 3 Create Client.

I din applikation

4. Hämta en token. Skicka Client ID och Client Secret till tokenslutpunkten. Anropets body måste vara formulärkodad:

curl -X POST https://app.muchskills.com/oauth2/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=DITT_CLIENT_ID" \
  -d "client_secret=DIN_CLIENT_SECRET"

Svaret innehåller access_token, token_type (Bearer), expires_in angivet i sekunder och det scope som har beviljats.

5. Anropa API:et. Skicka token i headern Authorization. Det här anropet returnerar de första 300 profilerna:

curl -X POST "https://app.muchskills.com/api/v2/profile/search?skip=0&limit=300" \
  -H "Authorization: Bearer DIN_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{}"

Om du bara vill läsa utvalda personer skickar du {"filters": {"emails": ["anna@yourcompany.com"]}} som body.

6. Bläddra igenom resultaten. Varje svar har ett pagination-objekt med total. Öka skip med ditt limit och upprepa tills du har fått alla. limit kan vara högst 300.

Kontrollera att det fungerar

• Tokenanropet returnerar 200 och en access_token.
• Sökanropet returnerar 200 med profilerna i data och total i pagination.
• På sidan API Access står det en tidpunkt i klientens kolumn Last used i stället för Never.

Det här får du

• Dina data i dina verktyg. Profiler, kompetenser, certifikat, mål och tillgänglighet flödar in i rapporter, datalager och andra system.
• Data in utan att någon knappar in dem. Skicka certifikat, kompetensnivåer, mål och frånvaro från systemen där de skapas.
• Kontroll per integration. Varje klient har sitt eget scope och kan återkallas separat.

Bra att veta

Vad du kan anropa. API:et har 22 endpoints. Alla sökvägar nedan börjar med https://app.muchskills.com.

Personer identifieras via e-postadress. Använd adressen som var och en loggar in i MuchSkills med.

Sökningen är en POST. POST /api/v2/profile/search svarar 404 på en GET. Sidindelningsvärdena anges i adressen som skip och limit, och filtren läggs i JSON-bodyn.

En token gäller i ungefär en timme. Det finns ingen refresh token. Begär en ny token när den gamla har gått ut eller när ett anrop svarar 401.

Skrivning kräver Write-scope. En klient med bara Read-scope, eller en äldre organisationstoken, får 403 på skrivanrop.

Frånvaroskrivningar ersätter allt. PUT /api/v2/profile/{email}/pto ersätter all frånvaro för personen, och en tom lista rensar den. Om en HR-integration hanterar frånvaron för din organisation svarar anropet 403. Ändra då frånvaron i HR-systemet i stället.

Kompetensnivåer anges på en skala från 1 till 9. 1 till 3 motsvarar Beginner, 4 till 6 Intermediate och 7 till 9 Expert. Profilerna visar personens självskattade nivå och, om en chef har validerat den, även den validerade nivån.

Privata filer kräver en header. Certifikat- och utbildningsfiler är privata. Svaren innehåller ett auth-objekt med den header du ska skicka när du öppnar dem. Headern går ut, och med GET /api/v2/auth/file-validation-header får du en ny.

Begränsningar för anrop. För många anrop på kort tid ger 429 Too Many Requests. Vänta och försök igen med allt längre paus, till exempel 1, 2 och sedan 4 sekunder. Målanropen tillåter ett anrop per sekund och token.

Äldre tokens fasas ut. Om MuchSkills fortfarande har en gammal organisationstoken för din webbplats visas meddelandet A legacy API token is still active for this site. på sidan Integrations. Flytta över varje integration till en API-klient.

Återkallning är slutgiltig. Med Revoke på sidan API Access slutar klientens inloggningsuppgifter att fungera direkt. Det går inte att ångra.

Felsökning