Base URL: /v2, Version: 2.19.0
L’API Opinion System est accessible à partir de l’adresse HTTPS suivante:
https://api.opinionsystem.fr/v2{path}?api_key={api_key}...
Pour télécharger le fichier swagger, veuillez cliquer sur le lien suivant:
https://api.opinionsystem.fr/v2/swagger.yaml
Avec ce fichier, vous pouvez générer un « client » pour notre API dans le langage de votre choix.
Simplement importer le fichier de définition et ensuite dans le menu « Generate Client » choisir votre langage.
Path | Operation | Description |
---|---|---|
/client/collaborator | DELETE |
Supprimer un collaborateur |
GET |
Liste des collaborateurs |
|
POST |
Ajouter un collaborateur |
|
PUT |
Mettre à jour un collaborateur |
|
/client/collaborator/rating | GET |
Évalutation d'un collaborateur |
/client/collaborator/survey | GET |
Évaluation détaillé d'un collaborateur |
/client/collaborator/url | GET |
URLs du collaborateur |
PUT |
Mettre à jour les URL d'un collaborateur |
|
/client/company | GET |
Liste d'adhérents |
/client/company/login | GET |
Générer un lien de connexion |
/client/company/rating | GET |
Évaluation d'un adhérent |
/client/company/survey | GET |
Évaluation détaillé d'un adhérent |
/client/company/url | GET |
URLs du adhérent |
PUT |
Mettre à jour les URL d'un adhérent |
|
/client/company/user | GET |
Liste d'utilisateurs |
/client/group | GET |
Liste des groupes |
/client/group/rating | GET |
Liste des groupes |
/client/group/survey | GET |
Liste des questionnaires d'un groupe |
/collaborator | GET |
Liste des collaborateurs |
/collaborator/rating | GET |
Évalutation d'un collaborateur |
/collaborator/survey | GET |
Évaluation détaillé d'un collaborateur |
/company | GET |
Liste d'adhérents |
/company/rating | GET |
Évaluation d'un adhérent |
/company/survey | GET |
Évaluation détaillé d'un adhérent |
/endpoint | GET |
Liste des {path} accessible avec votre clé API |
/group | GET |
Liste des groupes |
/group/rating | GET |
Évaluation d'un groupe |
/group/survey | GET |
Évaluation détaillé d'un groupe |
/relation | GET |
Association de SIRET |
/sector | GET |
Liste des secteurs |
/sector/rating | GET |
Évaluations d'un secteur |
/sector/survey | GET |
Évaluation détaillé d'un secteur |
/survey | GET |
Liste des questionnaires. |
/survey/category | GET |
Liste des catégories de questionnaire. |
/survey/question | GET |
Légendes texte des questions. |
/survey/send | POST |
Envoi d'un questionnaire. |
/survey/status | GET |
Statut d'un questionnaire. |
/user | GET |
Liste des utilisateur. |
/user/identity | DELETE |
Supprimer une identité |
GET |
Information d'un identité |
|
POST |
Enregistrer un identité |
|
PUT |
Mettre à jour un identité |
|
/widget/company/statistic | GET |
Générer un lien de connexion |
collaborator_id ou external_id est obligatoire
collaborator_id |
ID du collaborateur |
formData | integer | |
external_id |
ID externe |
formData | string |
Uses default content-types: application/json
No Content
Bad Request
Missing Authentication Token
Permet d’obtenir la liste des collaborateurs disponibles.
company_id |
ID de l'adhérent |
query | integer | |
external_id |
ID externe |
query | string | |
Adresse mail du collaborateur |
query | string | ||
siret |
SIRET du collaborateur |
query | string | |
collaborator_id |
ID du collaborateur |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
company_id |
ID de l'adhérent |
formData | integer (int32) | |
external_id |
ID externe |
formData | string | |
first_name |
Prénom du collaborateur |
formData | string | |
last_name |
Nom du collaborateur |
formData | string | |
title |
Titre du collaborateur |
formData | string | |
E-mail du collaborateur |
formData | string | ||
siret |
SIRET du collaborateur |
formData | string |
Uses default content-types: application/json
OK
Bad Request
Missing Authentication Token
collaborator_id ou external_id est obligatoire
external_id |
ID externe |
formData | string | |
collaborator_id |
ID du collaborateur |
formData | integer (int32) | |
first_name |
Prénom du collaborateur |
formData | string | |
last_name |
Nom du collaborateur |
formData | string | |
title |
Titre du collaborateur |
formData | string | |
E-mail du collaborateur |
formData | string | ||
siret |
SIRET du collaborateur |
formData | string |
Uses default content-types: application/json
OK
Bad Request
Missing Authentication Token
Permet de récupérer les évaluations détaillées d’un collaborateur.
company_id |
ID de l'adhérent |
query | integer | |
collaborator_id |
ID du collaborateur |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer les évaluations détaillées des questionnaires d’un collaborateur
collaborator_id |
ID du collaborateur |
query | integer | |
company_id |
ID de l'adhérent |
query | integer | |
category_id |
ID de la catégorie |
query | integer | |
language |
Language de l'avis (3 lettres ISO 639-2/B) |
query | integer | |
limit |
nombre de questionnaire retourné |
query | integer | |
offset |
index du premier questionnaire |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet d'afficher les URL vers les questionnaires ou les certificats
collaborator_id |
ID du collaborateur |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
collaborator_id |
ID du collaborateur |
formData | integer (int32) | |
certificate |
lien vers les certificats |
formData | string | |
survey |
lien vers les questionnaires |
formData | string |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer une liste d'adhérents
company_id |
ID de l'adhérent |
query | integer | |
group_id |
ID du groupe |
query | integer | |
sector_id |
ID du secteur |
query | integer | |
siret |
Siret de l'adhérent |
query | string || array | |
phone |
Téléphone de l'adhérent |
query | string || array |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de générer un lien HTTP pour accéder au compte client décrit par les paramètres plus bas. Le lien est valide pour seulement une période de 5 minutes. Si aucun user_id n'est spécifié, alors le système tentera d'utiliser le compte du gestionnaire de l'adhérent.
company_id |
ID de l'adhérent |
query | integer | |
user_id |
ID de l'utilisateur |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer les évaluations détaillées d’un adhérent
company_id |
ID de l'adhérent |
query | integer | |
category_id |
ID de la catégorie |
query | integer | |
group_id |
ID du groupe |
query | integer | |
sector_id |
ID du secteur |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer les évaluations détaillées des questionnaires d’une entreprise
company_id |
ID de l'adhérent |
query | integer | |
group_id |
ID du groupe |
query | integer | |
sector_id |
ID du secteur |
query | integer | |
category_id |
ID de la catégorie |
query | integer | |
language |
Language de l'avis (3 lettres ISO 639-2/B) |
query | integer | |
limit |
nombre de questionnaire retourné |
query | integer | |
offset |
index du premier questionnaire |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet d'afficher les URL vers les questionnaires ou les certificats
company_id |
ID de l'adhérent |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
company_id |
ID de l'ahrérent |
formData | integer (int32) | |
certificate |
lien vers les certificats |
formData | string | |
survey |
lien vers les questionnaires |
formData | string |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de générer une liste des utilisateurs d'un adhérent.
company_id |
ID de l'adhérent |
query | integer | |
user_id |
ID de l'utilisateur |
query | integer |
Uses default content-types: application/json
OK
No Content
Bad Request
Missing Authentication Token
Permet d’obtenir la liste des groupes disponibles.
group_id |
ID du groupe |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer les évaluations détaillées d’un groupe.
group_id |
ID du groupe |
query | integer | |
category_id |
ID de la catégorie |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet d’obtenir la liste des questionnaires d'un groupe.
group_id |
ID du groupe |
query | integer | |
category_id |
ID de la catégorie |
query | integer | |
language |
Language de l'avis (3 lettres ISO 639-2/B) |
query | integer | |
limit |
nombre de questionnaire retourné |
query | integer | |
offset |
index du premier questionnaire |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet d’obtenir la liste des collaborateurs disponibles.
collaborator_id |
ID du collaborateur |
query | integer | |
company_id |
ID de l'adhérent |
query | integer | |
Adresse mail du collaborateur |
query | string | ||
siret |
SIRET du collaborateur |
query | string |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer les évaluations détaillées d’un collaborateur.
company_id |
ID de l'adhérent |
query | integer | |
collaborator_id |
ID du collaborateur |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer les évaluations détaillées des questionnaires d’un collaborateur
company_id |
ID de l'adhérent |
query | integer | |
collaborator_id |
ID du collaborateur |
query | integer | |
category_id |
ID de la catégorie |
query | integer | |
language |
Language de l'avis (3 lettres ISO 639-2/B) |
query | integer | |
limit |
nombre de questionnaire retourné |
query | integer | |
offset |
index du premier questionnaire |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer une liste d'adhérents
company_id |
ID de l'adhérent |
query | integer | |
group_id |
ID du groupe |
query | integer | |
sector_id |
ID du secteur |
query | integer | |
siret |
Siret de l'adhérent |
query | string || array | |
phone |
Téléphone de l'adhérent |
query | string || array |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer les évaluations détaillées d’un adhérent
company_id |
ID de l'adhérent |
query | integer | |
group_id |
ID du groupe |
query | integer | |
sector_id |
ID du secteur |
query | integer | |
category_id |
ID de la catégorie |
query | integer | |
siret |
Siret de l'adhérent |
query | string || array | |
phone |
Téléphone de l'adhérent |
query | string || array |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer les évaluations détaillées des questionnaires d’une entreprise
company_id |
ID de l'adhérent |
query | integer | |
group_id |
ID du groupe |
query | integer | |
sector_id |
ID du secteur |
query | integer | |
category_id |
ID de la catégorie |
query | integer | |
language |
Language de l'avis (3 lettres ISO 639-2/B) |
query | integer | |
siret |
Siret de l'adhérent |
query | string || array | |
phone |
Téléphone de l'adhérent |
query | string || array | |
limit |
nombre de questionnaire retourné |
query | integer | |
offset |
index du premier questionnaire |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer une liste de {path} accessible avec votre clé API
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet d’obtenir la liste des groupes disponibles.
group_id |
ID du groupe |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer les évaluations détaillées d’un groupe
group_id |
ID de l'adhérent |
query | integer | |
category_id |
ID de la catégorie |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer les évaluations détaillées des questionnaires d’un groupe
group_id |
ID du groupe |
query | integer | |
category_id |
ID de la catégorie |
query | integer | |
language |
Language de l'avis (3 lettres ISO 639-2/B) |
query | integer | |
siret |
SIRET de l'adhérent |
query | string | |
limit |
nombre de questionnaire retourné |
query | integer | |
offset |
index du premier questionnaire |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet d'associer un SIRET à une compagnie ou un groupe
company_id |
ID de l'adhérent |
query | integer | |
siret |
SIRET de l'adhérent |
query | string | |
forward |
Commande de destination |
query | string |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet d’obtenir la liste des secteurs disponibles.
sector_id |
ID du secteur |
query | integer | |
language |
Langue du secteur |
query | string fre |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer les évaluations détaillées d’un secteur.
sector_id |
ID du secteur |
query | integer | |
category_id |
ID de la catégorie |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer les évaluations détaillées des questionnaires d’un secteur
sector_id |
ID du secteur |
query | integer | |
category_id |
ID de la catégorie |
query | integer | |
language |
Language de l'avis (3 lettres ISO 639-2/B) |
query | integer | |
limit |
nombre de questionnaire retourné |
query | integer | |
offset |
index du premier questionnaire |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet d’obtenir la liste des questionnaires disponibles.
company_id |
ID de l'adhérent |
query | integer (int32) | |
siret |
SIRET de l'adhérent |
query | string |
Uses default content-types: application/json
OK
No Content
Bad Request
Missing Authentication Token
Permet d’obtenir la liste des catégories de questionnaire disponibles.
company_id |
ID de l'adhérent |
query | integer (int32) | |
group_id |
ID du groupe |
query | integer (int32) | |
sector_id |
ID du sectrue d'activité |
query | integer (int32) |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de récupérer les légendes texte dans une langue particulière pour les questions d’évaluation
company_id |
ID de l'adhérent |
query | integer | |
siret |
SIRET de l'adhérent |
query | string | |
language |
Langue des questions |
query | string fre |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet d’envoyer un questionnaire.
Ici, {company_id} ou {siret} est obligatoire, de même que {phone} ou {email}.
{phone} doit être en format international (exemple: 05 33 52 06 54 => +33 5 33 52 06 54)
company_id |
ID de l'adhérent |
formData | integer | |
collaborator_id |
ID du collaborateur |
formData | integer | |
question_id |
ID du questionnaire interne |
formData | integer | |
survey_category_id |
ID de la catégorie |
formData | integer | |
siret |
SIRET de l'adhérent |
formData | string | |
first_name |
Prénom du client |
formData | string | |
last_name |
Nom du client |
formData | string | |
phone |
Téléphone du client |
formData | string | |
E-mail du client |
formData | string | ||
postal_code |
Code postal du client |
formData | string | |
city |
Ville du client |
formData | string | |
country |
Pays du client (2 lettres ISO alpha-2) |
formData | string | |
invoice_detail |
Détail de la prestation |
formData | string | |
invoice_period |
Date de prestation (YYYY-MM) |
formData | string (date) | |
language |
Langue du client (3 lettres ISO 639-2/B) |
formData | string fre |
Uses default content-types: application/json
Ok
OK
No Content
Bad Request
Missing Authentication Token
Permet d’obtenir le statut d’un questionnaire de satisfaction envoyé.
company_id |
ID de l'adhérent |
query | integer | |
survey_id |
ID du questionnaire |
query | integer |
Uses default content-types: application/json
OK
No Content
Missing Authentication Token
Permet de générer une liste d'utilisateurs.
company_id |
ID de l'adhérent |
query | integer | |
user_id |
ID de l'utilisateur |
query | integer | |
group_id |
ID du groupe |
query | integer |
Uses default content-types: application/json
OK
No Content
Bad Request
Missing Authentication Token
user_id ou name_id est obligatoire
user_id |
ID de l’utilisateur de notre system. |
formData | integer | |
name_id |
ID qui represente l'utilisateur du coter du Identity Provider. |
formData | string |
Uses default content-types: application/json
OK
Bad Request
Missing Authentication Token
Permet d’obtenir de l’information sur un ou plusieur “User Identity”
user_identity_id |
ID du "User Identity" |
query | integer |
Uses default content-types: application/json
OK
No Content
Bad Request
Missing Authentication Token
permet de générer un identité qui vas être utiliser pour connecter via le system Single Sign On.
user_id |
ID de l’utilisateur de notre system. |
formData | integer | |
name_id |
ID qui represente l'utilisateur du coter du Identity Provider. |
formData | string |
Uses default content-types: application/json
OK
OK
Bad Request
Missing Authentication Token
Conflict - Duplicate
Seulement le name_id peux etre modifier.
user_id |
ID de l’utilisateur de notre system. |
formData | integer | |
name_id |
ID qui represente l'utilisateur du coter du Identity Provider. |
formData | string |
Uses default content-types: application/json
OK
Bad Request
Missing Authentication Token
Permet de générer un lien HTTP pour accéder au compte client décrit par les paramètres plus bas. Le lien est valide pour seulement une période de 5 minutes. Si aucun user_id n'est spécifié, alors le système tentera d'utiliser le compte du gestionnaire de l'adhérent.
company_id |
ID de l'adhérent |
query | integer |
Uses default content-types: application/json
OK
No Content
Bad Request
Missing Authentication Token