Référence API

Aperçu

Vos recrutements.
Connectés à votre écosystème.

Cette page présente la manière dont une future API Pro.Pulse pourrait vous permettre de relier vos outils à vos offres, candidatures et entretiens.

Retrouvez les premiers repères de lecture et un exemple de requête, dans une présentation pensée pour les développeurs.

Voir le premier exemple

Un point d’entrée,
votre environnement.

Un aperçu des échanges à imaginer autour de vos recrutements.

REST envisagéJSONHTTPS

Disponibilité: En préparation
Version: Non publiée
Exécution: Exemples uniquement

Des échanges lisibles

L’exemple ci-dessous adopte les conventions d’une API REST : une ressource identifiée par une URL, une méthode HTTP et une représentation JSON.

Dans cette illustration, GET représente la consultation d’une ressource. Le préfixe /v1 sert uniquement à montrer comment une version pourrait être indiquée.

Les noms des ressources, les paramètres et les règles de pagination seront précisés lors de l’implémentation.

URL DE BASE ILLUSTRATIVEFictive

https://api.pro-pulse.example/v1

Le domaine .example est utilisé pour cette démonstration. Il ne donne accès à aucun service.

Format de l’exempleapplication/json

Authentification

Le schéma illustré utilise un jeton Bearer transmis dans l’en-tête Authorization de la requête.

La valeur pp_demo_non_fonctionnelle est un exemple. Aucune clé n’est émise ni vérifiée depuis cette page.

Lorsque l’API sera disponible, les modalités d’accès et de protection des clés seront détaillées dans la documentation.

En-têtes illustratifsHTTP

Authorization: Bearer pp_demo_non_fonctionnelle
Accept: application/json

Consulter une liste d’offres

Voici à quoi pourrait ressembler une première requête de lecture. L’exemple demande une liste d’offres, limitée à trois éléments.

GET/v1/jobsIllustration

Paramètre illustré

limitentierfacultatif

Nombre d’éléments demandé dans l’exemple. Les valeurs autorisées et le comportement final ne sont pas encore définis.

Le code peut être copié pour en examiner la structure. Aucun bouton de cette page n’envoie de requête à une API.

GET/v1/jobs

cURLExemple fictif

curl --request GET \
  --url 'https://api.pro-pulse.example/v1/jobs?limit=3' \
  --header 'Authorization: Bearer pp_demo_non_fonctionnelle' \
  --header 'Accept: application/json'

const response = await fetch(
  'https://api.pro-pulse.example/v1/jobs?limit=3',
  {
    headers: {
      Authorization: 'Bearer pp_demo_non_fonctionnelle',
      Accept: 'application/json'
    }
  }
);

const jobs = await response.json();

import json
from urllib.request import Request, urlopen

request = Request(
    'https://api.pro-pulse.example/v1/jobs?limit=3',
    headers={
        'Authorization': 'Bearer pp_demo_non_fonctionnelle',
        'Accept': 'application/json'
    }
)

with urlopen(request) as response:
    jobs = json.load(response)

Voir une réponse illustrative200 OK

{
  "data": [
    {
      "id": "job_demo_001",
      "title": "Chef de projet",
      "status": "published",
      "location": "Paris"
    }
  ],
  "has_more": false
}

Données et structure fictives, présentées uniquement pour illustrer la lecture d’une réponse JSON.