The Blog

Comment peut-on vous aider?

View Categories

À propos de l’api de STAGE+

Introduction

L’API REST de STAGE+ permet d’accéder de manière programmatique aux données de gestion des stages. Cette API est
conçue pour faciliter l’intégration avec des outils d’analyse comme Power BI, ainsi que pour permettre aux
développeurs de créer des applications personnalisées.

Vue d’ensemble

L’API STAGE+ offre un accès sécurisé aux ressources suivantes :

  • Accès et contrôles d’accès : Gestion des droits d’accès aux stages
  • Demandes de stage : Consultation et gestion des demandes
  • Stages : Informations détaillées sur les stages disponibles et en cours

Authentification

Clé d’API

Toutes les requêtes à l’API STAGE+ nécessitent une authentification par clé d’API. Cette clé doit être incluse dans
l’en-tête de chaque requête.

En-tête requis :

Authorization: Bearer VOTRE_CLE_API

Obtention d’une clé d’API

  1. Accédez à la section « Clés d’API » de votre compte STAGE+
  2. Renseignez les informations requises :
    • Nom du service ou du propriétaire
    • Description de l’utilisation prévue
  3. Générez votre clé secrète
Important : Conservez cette clé en lieu sûr, elle ne sera affichée qu’une seule fois.

Métadonnées de la clé :

  • Mise à jour : Date de dernière modification
  • Auteur : Créateur de la clé
  • Nom du service : Identification de l’application utilisant la clé

URL de base

Environnement de développement :

https://client.stageplus.ca/api/v1
Note : Remplacez client.stageplus.ca par l’URL de production appropriée
lors du déploiement.

Format des données

  • Format de requête : JSON
  • Format de réponse : JSON
  • Encodage : UTF-8

En-têtes recommandés

Content-Type: application/json
Accept: application/json
Authorization: Bearer VOTRE_CLE_API

Points de terminaison disponibles

L’API STAGE+ expose les endpoints suivants :

Endpoint Description Méthodes
/acces Accès identifiés d’un stage GET, POST
/acces_identifies Gestion des accès identifiés GET
/acces_cip Accès par code identification personnel GET
/acces_requis Accès requis pour un stage GET
/demandes_stage Demandes de stage GET, POST, PUT
/stages Informations sur les stages GET, POST, PUT

Codes de statut HTTP

L’API utilise les codes de statut HTTP standard :

Code Signification Description
200 OK Requête réussie
201 Created Ressource créée avec succès
400 Bad Request Paramètres de requête invalides
401 Unauthorized Clé d’API manquante ou invalide
403 Forbidden Accès refusé à la ressource
404 Not Found Ressource non trouvée
500 Internal Server Error Erreur serveur

Format des erreurs

Les erreurs sont retournées au format JSON :

{
"error": {
"code": "INVALID_API_KEY",
"message": "La clé d'API fournie est invalide ou expirée",
"details": {}
}
}

Pagination

Les endpoints retournant des collections de données supportent la pagination :

Paramètres de requête :

  • page : Numéro de page (commence à 1)
  • limit : Nombre d’éléments par page (max: 100, défaut: 25)

Exemple :

GET /api/v1/stages?page=2&limit=50

Limites de taux (Rate Limiting)

Pour garantir la disponibilité du service, l’API applique des limites :

  • 1000 requêtes par heure par clé d’API
  • 100 requêtes par minute par clé d’API

Les en-têtes de réponse incluent :

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Intégration avec Power BI

STAGE+ peut être configuré comme source de données commune dans Power BI. Consultez le wiki STAGE+ our un guide détaillé d’intégration.

Support et ressources

  • Documentation : Documentation complète et guides d’utilisation
  • Support technique : Contactez votre administrateur
  • Changelog : Historique des versions de l’API

Versioning

L’API utilise un versioning dans l’URL (/v1/). Les versions majeures sont maintenues pour assurer la compatibilité ascendante.
Version actuelle : v1