Logo Harvest
redocly logo API docs by Redocly

Harvest API - Référentiels O2S (0.9.3)

Download OpenAPI specification:Download

API permettant de récupérer différentes référentiels d'O2S.

Cette API offre différents services permettant de récupérer des éléments des différents référentiels d'O2S. Pour ce faire, plusieurs Endpoint sont à disposition, à savoir :

  • /referentiels/contact-professions: Permet de récupérer la liste des éléments de la table contact-professions.
  • /referentiels/contact-capacites: Permet de récupérer la liste des éléments de la table contact-capacites.
  • /referentiels/contact-origines: Permet de récupérer la liste des éléments de la table contact-origines.
  • /referentiels/contact-qualites: Permet de récupérer la liste des éléments de la table contact-qualites.

Règlement Général sur la Protection des Données (RGPD)

Dans le cadre de la mise à disposition de l’API, HARVEST s’engage à effectuer pour le compte du Client responsable de traitement, les opérations de traitement de données à caractère personnel en qualité de sous-traitant. A ce titre, HARVEST et le Client s’engagent à respecter la réglementation en vigueur applicable au traitement de données à caractère personnel en particulier, le règlement (UE) 2016/679 du Parlement européen et du Conseil du 27 avril 2016 (ci-après le « RGPD »).

L’API peut vous permettre de renseigner librement des propriétés typées et non typées. HARVEST attire votre attention sur la nécessité, lors de la complétude de ces propriétés, de respecter les dispositions du RGPD. Dès lors, seules les données adéquates, pertinentes et strictement nécessaires au regard de la finalité des traitements réalisés par l’API doivent être transmises.

L’API contient par ailleurs des zones de commentaires libres dans lesquelles vous devez impérativement rédiger des commentaires objectifs, jamais excessifs ou insultants. Aussi, vous devez exclure toute donnée considérée comme sensible (origine raciale ou ethnique, opinions politiques, philosophiques ou religieuses, appartenance syndicale, données relatives à la santé ou à la vie sexuelle, infractions, condamnations, mesure de sûreté). En cas de doute, vous pouvez contacter votre DPO qui vous indiquera ce qu’il est possible de rédiger pour ne pas porter atteinte aux droits des personnes concernées.

Sécurité

Généralité

Pour utiliser l'API O2S, vous devez préalablement vous authentifier en suivant le protocole OAuth2 "password grant type" afin de récupérer un jeton (JWT) d'accès.

Informations nécessaires

Les informations nécessaires à l'obtention d'un jeton sont constituées :

  • d'informations fournies par Harvest qui sont spécifiques à votre application (client_id + client_secret)
  • d'informations spécifiques à un utilisateur O2S (username + password) dont l'API reprendra l'identité.

Il vous faut renseigner ces informations dans la ressource en entrée du service d'obtention d'un nouveau jeton.

Utilisation du jeton d'accès

Le jeton JWT doit être fourni lors de l'appel de chaque requête à l'API. Il doit être ajouté dans l'entête HTTP Authorization comme ceci : Authorization: Bearer <JWT>

OAuthPasswordAuthenticate

Le jeton JWT d'accès à exploiter est retourné dans valeur de la propriété access_token.

Il doit être précisé dans l'entête HTTP de toutes les requêtes (sauf celle d'authentification) comme ceci :

Authorization: Bearer <access_token>

Authorizations:
JWT
Request Body schema: application/x-www-form-urlencoded
grant_type
required
string
Value: "password"

Méthode d'authentification OAuth à définir obligatoirement à password.

client_id
required
string

Identifiant de l'application cliente.

client_secret
required
string

Secret de l'application cliente.

username
required
string

Identifiant de connexion de l'utilisateur.

password
required
string

Mot de passe de l'utilisateur.

Responses

Request samples

Content type
application/x-www-form-urlencoded
grant_type=password&client_id=clientId&client_secret=clientSecret&username=username&password=password

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOi...fgWOZZmV7Q",
  • "expires_in": 86400,
  • "refresh_expires_in": 86400,
  • "refresh_token": "eyJhbGciOi...KiIVIifWw",
  • "token_type": "bearer",
  • "not-before-policy": 1602682985,
  • "session_state": "85d20350-891b-4dad-b6ed-c411c6ac870c",
  • "scope": "..."
}

Réponse en cas de problème

Les réponses principales de l'API sont décrites au niveau de chacune de ses ressources (GET, POST, PUT, DELETE...).

Celles qui n'y sont pas spécifiées sont celles retournées en cas de problème soit avec la requête elle-même soit avec le serveur ou son environnement.

Les statuts HTTP concernés par ces dernières sont les 4xx (hors 404) et 5xx.

Le format des réponses répond au schéma Problem Zalando.

ReferentielsO2S

Opérations sur les référentiels O2S.

Récupérer la liste contact-professions.

Récupère la liste des éléments de contact-professions correspondant aux critères de recherche.

Authorizations:
JWT
query Parameters
code
string (CodeType)
Example: code=Agent de l'État

Permet de récupérer uniquement l'uuid d'un code précis.

Responses

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    }
]

Récupérer la liste contact-capacites.

Récupère la liste des éléments de contact-capacites correspondant aux critères de recherche.

Authorizations:
JWT
query Parameters
code
string (CodeType)
Example: code=Agent de l'État

Permet de récupérer uniquement l'uuid d'un code précis.

Responses

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    }
]

Récupérer la liste contact-origines.

Récupère la liste des éléments de contact-origines correspondant aux critères de recherche.

Authorizations:
JWT
query Parameters
code
string (CodeType)
Example: code=Agent de l'État

Permet de récupérer uniquement l'uuid d'un code précis.

Responses

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    }
]

Récupérer la liste contact-qualites.

Récupère la liste des éléments de contact-qualites correspondant aux critères de recherche.

Authorizations:
JWT
query Parameters
code
string (CodeType)
Example: code=Agent de l'État

Permet de récupérer uniquement l'uuid d'un code précis.

Responses

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    }
]