Logo Harvest
redocly logo API docs by Redocly

Harvest API - Documents O2S (0.9.3)

Download OpenAPI specification:Download

API de gestion des documents O2S

Cette API offre différents services permettant de gérer des documents O2S ainsi que les informations liées.

Pour ce faire, plusieurs ressources sont à disposition, à savoir :

  • Document : Permet de gérer l'entité de base de cette API que sont les documents.
  • Catégorie : Permet de gérer les catégories des documents.

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.

Document

Opérations sur les documents O2S

Lister des Documents

Récupère une liste de Document correspondant aux critères facultatifs de recherche.
Par défaut :

  • aucun filtre n'est appliqué (permet de récupérer tous les Documents)
  • le nombre d'éléments retournés est limité à 20
Authorizations:
JWT
query Parameters
contactId
string
Example: contactId=ec3dee9a-a6fc-11e9-b9bd-0050568a56f0

Référence (id) du contact détenteur des documents recherchés

type
string (TypeDoc)
Enum: "IDENTITE" "JUSTIFICATIF_DOMICILE" "JUSTIFICATIF_AUTRE" "INFORMATION_LEGALE" "AUTRE"

Le type de document:

  • IDENTITE
  • JUSTIFICATIF_DOMICILE
  • JUSTIFICATIF_AUTRE
  • INFORMATION_LEGALE
  • AUTRE
contenu
boolean
Default: false

Permet d'indiquer si le contenu du document est récupéré.

limit
integer
Default: 20

Nombre maximum de documents à retourner

offset
integer
Default: 0

Indice (0-based) du premier document à retourner

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Créer un Document

Crée un nouvel Document.

Authorizations:
JWT
Request Body schema: application/json

Les données d'un Document à créer.

id
string

Identification du document.

libelle
string

Libellé générique du document.

type
string (TypeDoc)
Enum: "IDENTITE" "JUSTIFICATIF_DOMICILE" "JUSTIFICATIF_AUTRE" "INFORMATION_LEGALE" "AUTRE"

Le type de document:

  • IDENTITE
  • JUSTIFICATIF_DOMICILE
  • JUSTIFICATIF_AUTRE
  • INFORMATION_LEGALE
  • AUTRE
dateCreation
string <date-time>

Date et heure de création d'un document.

dateMaj
string <date-time>

Dernière date et heure de modification d'un document.

object

Extension Contenu d'un document.

Array of objects (TypeDocumentRessourceLiee)

Extension RessourcesLiees d'un document.

object

Extension MetaDonnees d'un document.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "libelle": "string",
  • "type": "IDENTITE",
  • "dateCreation": "2019-08-24T14:15:22Z",
  • "dateMaj": "2019-08-24T14:15:22Z",
  • "contenu": {
    },
  • "ressourcesLiees": [
    ],
  • "metaDonnees": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Obtenir un Document

Récupère les données d'un unique Document.

Authorizations:
JWT
path Parameters
documentId
required
string (TypeId) [ 1 .. 100 ] characters

Référence (id) du document

query Parameters
contenu
boolean
Default: true

Permet d'indiquer si le contenu du document est récupéré.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "libelle": "string",
  • "type": "IDENTITE",
  • "dateCreation": "2019-08-24T14:15:22Z",
  • "dateMaj": "2019-08-24T14:15:22Z",
  • "contenu": {
    },
  • "ressourcesLiees": [
    ],
  • "metaDonnees": {
    }
}

Mettre à jour un Document

Met à jour un Document existant.

Authorizations:
JWT
path Parameters
documentId
required
string (TypeId) [ 1 .. 100 ] characters

Référence (id) du document

Request Body schema: application/json

Les données d'un Document à mettre à jour.

id
string

Identification du document.

libelle
string

Libellé générique du document.

type
string (TypeDoc)
Enum: "IDENTITE" "JUSTIFICATIF_DOMICILE" "JUSTIFICATIF_AUTRE" "INFORMATION_LEGALE" "AUTRE"

Le type de document:

  • IDENTITE
  • JUSTIFICATIF_DOMICILE
  • JUSTIFICATIF_AUTRE
  • INFORMATION_LEGALE
  • AUTRE
dateCreation
string <date-time>

Date et heure de création d'un document.

dateMaj
string <date-time>

Dernière date et heure de modification d'un document.

object

Extension Contenu d'un document.

Array of objects (TypeDocumentRessourceLiee)

Extension RessourcesLiees d'un document.

object

Extension MetaDonnees d'un document.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "libelle": "string",
  • "type": "IDENTITE",
  • "dateCreation": "2019-08-24T14:15:22Z",
  • "dateMaj": "2019-08-24T14:15:22Z",
  • "contenu": {
    },
  • "ressourcesLiees": [
    ],
  • "metaDonnees": {
    }
}

Supprimer un Document

Supprime un Document existant.

Authorizations:
JWT
path Parameters
documentId
required
string (TypeId) [ 1 .. 100 ] characters

Référence (id) du document

Responses

Catégorie

Opérations sur les catégories des documents O2S

Lister les catégories des Documents

Récupère une liste de Catégories Document correspondant aux critères de recherche.

Authorizations:
JWT
query Parameters
contactId
required
string (TypeId) [ 1 .. 100 ] characters
Example: contactId=ec3dee9a-a6fc-11e9-b9bd-0050568a56f0

Référence (id) du contact

Responses

Response samples

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