De Reach 360 API is georganiseerd rond REST. Onze API heeft voorspelbare resource-georiënteerde URL's, accepteert JSON-gecodeerde verzoekteksten, retourneert JSON-gecodeerde antwoorden en maakt gebruik van standaard HTTP-responscodes, authenticatie en werkwoorden.

• De Reach 360 API is beschikbaar op https://api.reach360.com
• De EU Reach 360 API is beschikbaar op https://api.reach360.eu

Voor de laatste updates, zie de Changelog.

Klik hier voor meer informatie over het genereren van API-sleutels in Reach 360.

• Verificatie
• Versiebeheer
• Paginering
• Fouten
• Ondersteuning

Verificatie

Uw API-sleutel wordt gebruikt om aanvragen te verifiëren en uw Reach 360-account te identificeren. Het moet veilig worden opgeslagen: zorg ervoor dat het geen versiebeheer heeft en dat het alleen toegankelijk is voor degenen die het nodig hebben. Behandel het zoals elk ander wachtwoord.

Alle API-aanvragen moeten Bearer Authentication gebruiken: uw API-sleutel moet als Bearer Token in de Authorization koptekst worden vermeld. Alle API-aanvragen moeten via HTTPS worden gedaan. Oproepen via gewone HTTP zullen mislukken. API-aanvragen zonder authenticatie zullen ook mislukken.

Versiebeheer

Als er wijzigingen worden aangebracht in onze API die niet compatibel zijn met eerdere versies, brengen we een nieuwe, gedateerde API-versie uit. De initiële API-versie van 2023-04-04 wordt verondersteld als uw verzoeken geen API-Version koptekst bevatten.

Als er een ongeldige koptekst voor de API-versie wordt verstrekt, ontvangt u een 400-reactie met de foutcodeinvalid_api_version. Succesvolle API-aanvragen bevatten een API-Version antwoordkop, die aangeeft met welke API-versie je aanvraag is verwerkt.

Telkens wanneer een nieuwe API-versie wordt uitgebracht, noemen we deze expliciet in onze Changelog, naast het aanmaken van een nieuw item op de pagina API-versies.

Voorbeeldaanvraag

curl -i < https://api.reach360.com/users >\\ 
 -H „Autorisatie: drager $API_KEY” -H „API-versie: 16-07-2020” 
 

Paginering

Alle gepagineerde eindpunten zijn gebaseerd op een cursor en geven een eigenschap terug. nextUrl Zo nietnull, dan nextUrl geeft dit aan dat er mogelijk aanvullende resultaten zijn. Er kan een GET verzoek worden gedaan naar de nextUrl URL om de volgende pagina met resultaten te krijgen. Een nextUrl van null geeft aan dat er geen verdere resultaten zijn. Alle gepagineerde eindpunten ondersteunen een limit querytekenreeksparameter die het maximale aantal resultaten specificeert dat in één antwoord moet worden geretourneerd. Alle eindpunten die een lijst met resultaten retourneren, ondersteunen paginering.

Opmerking: De limit waarde moet tussen 1 en 100 liggen (tenzij anders vermeld; en is standaard 50 indien niet gespecificeerd).

Eindpunten die paginering ondersteunen

• GET /courses
• GET /groups
• GET /groups/{groupId}/users
• GET /invitations
• GET /learning-paths
• GET /learning-paths/{learningPathId}
• GET /learning-paths/{learningPathId}/courses
• GET /groups/{groupId}/managers
• GET /users/{userId}/managing-groups
• GET /reports/activity
• GET /reports/courses/{courseId}
• GET /reports/learners/{userId}
• GET /reports/learning-paths/{learningPathId}/courses
• GET /reports/learning-paths/{learningPathId}/learners
• GET /users
• GET /users/{userId}/groups
• GET /groups/{groupId}/reporters
• GET /users/{userId}/reporting-groups
• GET /webhooks

Fouten

Een antwoord van 400 met een lijst van antwoorden errors wordt teruggestuurd als het verzoek niet geldig is. Enkele veelvoorkomende foutcodes zijn:

• validation_failed: De hoofdtekst van het verzoek bevat een validatiefout
• invalid_email: De email eigenschap heeft geen correct geformatteerd e-mailadres
• missing_api_key: De aanvraag mist een API-sleutel
• invalid_api_key: De opgegeven API-sleutel is ongeldig
• invalid_content_type: De aanvraag ontbreekt/bevat het verkeerde inhoudstype

Voorbeeldreactie

{
„errors”: [
{
„code”: „invalid_email”, 
 „message”: „\\" email\\” moet een geldig e-mailadres zijn”
}]} 
 
 

Ondersteuning

We vinden het geweldig dat je Reach 360 kunt verbinden met de tools die je het meest gebruikt. Ondersteuning kan bevestigen of API-aanroepen naar verwachting werken, maar we kunnen niet helpen met het schrijven van aangepaste scripts of het debuggen van toepassingen van derden.

Als je toch tegen een probleem aanloopt, doen we ons best om je te helpen het probleem op te lossen door te vragen om:

• De eenvoudigste versie van de aanroep die je maakt met de API
• Of het probleem kan worden gerepliceerd buiten uw toepassing
• Verzoekkopteksten, antwoordheaders (inclusief de X-Request-Id-header), verzoekteksten en antwoordorganen

Neem contact op met ons team en laat ons weten wat er gebeurt. Vanaf daar gaan we verder!