Récupération des candidats

{
	"success": true,
	"message": "Récupération de la liste des candidats actuellement en Base de Données",
	"candidates": [
		{
			"id": 1,
			"dobCandidate": "2023-12-15T00:00:00+00:00",
			"emailCandidate": "contact@api.adrar.dev",
			"uuidCandidate": "00000000-0000-0000-0000-000000000000",
			"isEnabledCandidate": true
		},
		// ...
	]
}

Récupération des informations d'un candidat

{
	"success": true,
	"message": "Récupération des éléments du candidat `contact@api.adrar.dev`",
	"candidate": {
		"id": 1,
		"dobCandidate": "2023-12-15T00:00:00+00:00",
		"emailCandidate": "contact@api.adrar.dev",
		"uuidCandidate": "00000000-0000-0000-0000-000000000000",
		"isEnabledCandidate": true
	}
}

Ajouter un candidat

{
	"success": true,
	"message": "Récupération de la liste des candidats actuellement en Base de Données",
	"candidates": [
		{
			"id": 1,
			"dobCandidate": "2023-12-15T00:00:00+00:00",
			"emailCandidate": "contact@api.adrar.dev",
			"uuidCandidate": "00000000-0000-0000-0000-000000000000",
			"isEnabledCandidate": true
		},
		// ...
	]
}

Mettre à jour un candidat

{
	"success": true,
	"message": "Mise à jour du candidat `contact@api.adrar.dev` effectuée",
	"candidate": {
		"id": 1,
		"dobCandidate": "2023-12-15T00:00:00+00:00",
		"emailCandidate": "contact@api.adrar.dev",
		"uuidCandidate": "00000000-0000-0000-0000-000000000000",
		"isEnabledCandidate": true
	}
}

Supprimer un candidat

{
	"success": true,
	"message": "Suppression du candidat `contact@api.adrar.dev` effectuée"
}

Configuration de Postman

Vous n'avez que quelques informations à renseigner pour effectuer un test auprès d'une

• (1) La méthode à utiliser: GET, POST, PUT, DELETE ;
• (2) L'URL à saisir ;
• (3) Les paramètres de la requête si demandés (ex: email, nom, date de naissance, ...).
• Cliquer sur Envoyer (Send) pour réaliser votre tentative

Comprendre et traiter le retour d'une API avec Postman

Le retour est au format JSON, c'est-à-dire un langage qui permet d'associer un identifiant à une donnée appellée «valeur».

L'identifiant «success» permet de voir que cela a fonctionné.

L'identifiant «message» permet de comprendre l'action réalisée.

L'identifiant «centers» qui correspond à ce qui a été saisi, permet de les lister.

Explications

Les états de services permettent de voir en temps réel quel est l'état de nos différents services. Ils ont pour but d'indiquer aux utilisateurs/trices qu'un service semble être défaillant, à quel moment, etc.

Key Performance Indicator (KPI - Indicateur clé de performance)

Les indicateurs clés de performance sont des mesures utilisées pour évaluer le succès ou l'efficacité d'une activité, d'un processus, d'un projet ou d'une organisation. Ils sont essentiels pour aider à comprendre si des objectifs spécifiques ont été atteints et pour suivre les progrès vers ces objectifs.

Listing des derniers incidents

Derniers incidents

Méthodes autorisées

Quelles sont les méthodes autorisées par l'API ?

L'API autorise les méthodes suivantes:

• GET pour la récupération d'informations
• POST pour l'insertion d'informations
• PUT/PATCH pour la modification d'informations
• DELETE pour la suppression d'informations

Pourquoi certaines méthodes ne sont pas autorisées ?

Le modèle de l'API est de type RESTful. Ce même modèle se base sur le modèle de Richardson qui n'autorise que les méthodes précisées ci-dessus.

Limites d'une API

Quelles sont les limites d'une API ?

L'API a une limite de débit. Ainsi, elle peut subir des ralentissements voire des dysfonctionnements lors de fortes demandes.

Comment contraindre une API à l'utilisation d'utilisateurs spécifiques ?

Il suffit de demander à ces mêmes utilisateurs de créer un accès sur notre plateforme. Dès lors, nous pourrons leur générer un token unique afin de les identifier et qui leur sera demandé à chaque tentative !

Aide pour l'exercice...

Vous êtes bloqué·e ? Vous ne savez plus comment avancer ? (fiche de guide)

Vous pouvez retrouver une fiche d'aide avec une aide pas à pas pour réussir l'exercice ici. Vous n'êtes pas obligé·e de la lire entièrement pour garder du challenge !

Vous êtes VRAIMENT bloqué·e ? (solution pas à pas)

Vous pouvez retrouver la fiche réponse avec les explications détaillées ici.