‭Rapportage-API's

SkillUp's Reporting APIs stellen je in staat om skill signalen, badges en certificeringsgegevens programmatisch uit te trekken uit je organisatie. Deze APIs maken het mogelijk om leerinzichten te integreren met HR-systemen, op maat gespecificeerde rapporten te maken en leerresultaten te koppelen aan bedrijfsimpact.

Opmerking: Alleen administrators kunnen credentials genereren om toegang te krijgen tot deze APIs.

Beschikbare eindpunten

Eindpunt

Beschrijving

Referenties API

Retourneert een lijst van alle beschikbare badges en certificaten in SkillUp.

Gebruikers API

Retourneert gebruikersgegevens, inclusief leervorderingen, badges en behaalde certificaten.

Rapportage-API's configureren

SkillUp APIs gebruiken de OAuth 2.0 Client Credentials flow voor veilige toegang. Alleen geautoriseerde systemen kunnen rapportagegegevens opvragen en ophalen.

Om rapportage-API's te configureren:

Stap 1: OAuth-referenties genereren

ReportingAPIs (2).gif
  1. Log in op SkillUp met een administratoraccount.

  2. Klik op je profielpictogram in de rechterbovenhoek en selecteer Instellingen.

  3. Klik op Registreer nieuwe toepassing.

  4. Voer een naam in voor je toepassing.

  5. Klik op Toepassing registreren.

  6. Kopieer de Client-ID en Clientgeheim naar het klembord of klik op JSON downloaden om de referenties als bestand op te slaan.

    Belangrijke opmerking: Het clientgeheim wordt alleen weergegeven tijdens het genereren. Je moet het veilig opslaan voordat je het dialoogvenster sluit, omdat je het niet opnieuw kunt ophalen.

Uw toepassing is nu succesvol geregistreerd en u kunt beginnen met het maken van API-aanvragen.

Stap 2: Toegangstoken aanvragen

Als beveiligingsmaatregel moet u eerst een toegangstoken verkrijgen door een POST-aanvraag te doen naar de /v1/oauth2/token eindpunt.

De Authorization-header moet uw clientreferenties in Base64-indeling bevatten.

  1. Combineer je client-ID en clientgeheim met een dubbele punt (:).
    Voorbeeld: client_id:client_secret

  2. Codeer de string met Base64.

  3. Voeg het voorvoegsel Basic toe aan de gecodeerde string om de Authorization-header te maken.
    Voorbeeld: Basic <base64_encoded_string>.

Opmerking: Het toegangs token (JWT) is geldig voor 10 minuten. Wanneer het verloopt, herhaal deze stappen om een nieuw token aan te vragen.

Voorbeeld

Als client_id = "abc123" en client_secret = "def456"
Gecombineerd: "abc123:def456"

Base64 gecodeerd:"YWJjMTIzOmRlZjQ1Ng=="

Eindheader:"Basic YWJjMTIzOmRlZjQ1Ng=="

Vraag

curl -X POST https://www.hackerrank.com/skillup/api/v1/oauth2/token \
-H "Authorization: Basic <base64_encoded_credentials>" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials"

Koppen

Hoofd

Vereist

Waarde

Autorisatie

Ja

Basis <base64_gecodeerde_referenties>

Content-Type

Ja

application/x-www-form-urlencoded

Lichaamsparameters

Parameter

Vereist

Waarde

grant_type

Ja

client_credentials

Antwoord

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 600
}

Veld

Type

Beschrijving

toegangstoken

reeks

De toegangstoken voor API-authenticatie

verlooptijd

geheel getal

Token geldigheidsperiode in seconden (600 seconden)

Stap 3: Toegang tot SkillUp-API's

Nadat u een geldige toegangscode hebt verkregen, gebruikt u deze om de SkillUp Reporting API's aan te roepen.

Voeg de token toe aan de Authorization-header van uw verzoek.

Voorbeeldverzoek

curl -X GET https://www.hackerrank.com/skillup/api/v2/credentials \
-H "Authorization: Bearer <access_token>"

Foutafhandeling

Statuscode

Fout

Beschrijving

400

Slecht verzoek

Ontbrekende of ongeldige parameters

401

Niet geautoriseerd

Toegangstoken is ongeldig of verlopen

403

Verboden

Token heeft vereiste machtigingen niet

429

Te veel verzoeken

Te veel verzoeken in korte tijd

Beste praktijken

  • Store credentials securely. Nooit clientreferenties blootstellen in client-side code.

  • Tokens blijven 10 minuten geldig. Cache en hergebruik toegangstokens in plaats van nieuwe te genereren voor elk verzoek

  • Vraag een nieuw token aan voordat het huidige token verloopt.

Snelheidslimieten

Vraagtype

Limiet

Tokenverzoeken

1 verzoek per seconde

API-verzoeken

1 verzoek per seconde

Voor meer informatie kunt u contact opnemen met skillup-support@hackerrank.com.‭