Aller au contenu
Nexus TéléchargerDémarrer

Clients

37 routes. Chemins relatifs à https://api.nexus-engine.eu/api/v1.

GET /clients

Les fiches clients de l’entreprise.

RéponseClientDto[]
GET /clients/:id

Une fiche client.

RéponseClientDto
GET /clients/:id/projects

Les projets reliés à un client.

RéponseClientProjectDto[]
GET /clients/:id/sortie

Aperçu de la sortie d’un client : ce qu’on rend, ce qu’on coupe, ce qu’on garde — avec l’empreinte à renvoyer.

RéponseSortieClientDto
NoteN’écrit rien. Une ligne à zéro ne s’affiche pas.
POST /clients/:id/sortie session de l’application seulement

Fait sortir le client : coupe ce que Nexus fait en son nom, rend ses accès si demandé.

Corpsnom (recopié), empreinte (de l’aperçu), rendreLesAcces, fermerLesComptes
NoteNe SUPPRIME rien. Refusé (400) si le nom ne correspond pas, (409) si quelque chose a changé depuis l’aperçu. Journalisé.
DELETE /clients/:id/sortie session de l’application seulement

Reprend un client sorti : la marque tombe.

NoteRien ne se rallume : ni surveillance, ni sauvegarde, ni abonnement. C’est au nouveau contrat de le dire.
GET /clients/fusion

Aperçu de la fusion de deux fiches clients en double : ce qui passerait de l’absorbée à la gardée.

NoteParamètres garder et absorber. N’écrit rien. 404 pour une fiche d’une autre entreprise.
POST /clients/fusion Owner et Admin

Fusionne deux fiches clients en double : projets, sites, accès, demandes, contacts passent à la gardée.

Corpsgarder, absorber, nom (celui de la fiche absorbée, recopié)
NoteDeux SIREN différents : refusé (409). Les vides de la gardée se remplissent, les notes s’ajoutent. Journalisé (client.fusionne).
POST /clients Owner et Admin

Crée une fiche client.

Corpsname, contactName, contactEmail, contactPhone, website, address, postalCode, city, country, siret, notes
RéponseClientDto
PATCH /clients/:id Owner et Admin

Modifie une fiche client (mêmes champs, tous facultatifs).

Corpsname, contactName, contactEmail, contactPhone, website, address, postalCode, city, country, siret, notes
RéponseClientDto
DELETE /clients/:id Owner et Admin

Supprime une fiche client.

Requêteprojects = keep (défaut, les projets restent sans client) ou cascade (les projets partent avec)
PUT /clients/:id/members Owner et Admin

Qui, dans l’agence, s’occupe de ce client. La liste remplace l’existante.

CorpsmemberIds
Réponse{ ok }
NoteOuvre la visibilité de ses demandes et les avis qui vont avec — ni le parc, ni le coffre.
GET /clients/:id/apercu/session Owner et Admin

L’en-tête de l’espace de suivi du client, tel qu’il le voit.

RéponsePortailSessionDto
NoteLecture seule : aucune session n’est ouverte au nom du client, et rien ne s’écrit de ce côté.
GET /clients/:id/apercu/discussion Owner et Admin

Son flux de discussion, dans la forme que le client lit.

RequêtesiteId, limit
RéponseDiscussionMessageDto[]
GET /clients/:id/apercu/demandes Owner et Admin

Ses demandes, dans la forme que le client lit.

RéponsePortailTicketDto[]
GET /clients/:id/apercu/demandes/:ticketId Owner et Admin

Une de ses demandes et son fil, dans la forme que le client lit.

RéponsePortailTicketDetailDto
GET /clients/:id/apercu/demandes/:ticketId/pieces/:pieceId Owner et Admin

Le contenu d’une pièce jointe, vue depuis l’aperçu.

Réponse{ name, mimeType, dataBase64 }
GET /clients/:id/apercu/rapports Owner et Admin

Les rapports de maintenance que le client retrouve dans son espace.

Réponse{ id, title, period, periodStart, periodEnd, sentAt, token }[]
GET /client-contacts

Tous les comptes du portail de l’entreprise, toutes sociétés confondues. Sert à NOMMER les personnes à qui l’on ouvre un accès du coffre, sans avoir à désigner leur société d’abord.

RéponseClientContactDto[]
GET /clients/:id/contacts

Les interlocuteurs d’un client, et l’état de leur accès au portail.

RéponseClientContactDto[]
POST /clients/:id/contacts Owner et Admin

Ouvre un accès au portail pour un interlocuteur : le courriel d’invitation part aussitôt. Une adresse déjà connue chez un autre client est rattachée (`rattache: true`), jamais recréée.

Corpsemail, firstName, lastName, jobTitle
RéponseClientContactCreatedDto
PATCH /client-contacts/:id Owner et Admin

Modifie un interlocuteur, ou retire son accès (ses sessions tombent).

CorpsfirstName, lastName, jobTitle, status
RéponseClientContactDto
DELETE /client-contacts/:id Owner et Admin

Supprime un accès. Avec `clientId`, ne retire que l’accès à ce client quand le compte en suit d’autres. Les demandes déjà déposées sont conservées.

RequêteclientId
Réponse{ ok, demandesConservees, compteConserve }
POST /client-contacts/:id/invitation Owner et Admin

Renvoie l’invitation : le lien précédent est invalidé.

Réponse{ courrielEnvoye, lien }
GET /clients/:id/sites

Les sites rattachés à un client — ceux que son portail proposera.

RéponseSiteDto[]
PUT /clients/:id/sites Owner et Admin

Rattache un lot de sites au client. La liste remplace l’existante.

CorpssiteIds
Réponse{ ok, rattaches }
GET /clients/:id/apercu/acces Owner et Admin

L’aperçu : les accès montrés au client, sans aucun secret.

RéponsePortailAccesDto[]
GET /clients/:id/apercu/utilisateurs Owner et Admin

L’aperçu : les personnes qui ont accès à l’espace du client.

RéponsePortailUtilisateurDto[]
GET /clients/:id/apercu/utilisateurs/:contactId/avatar Owner et Admin

L’aperçu : le portrait d’un interlocuteur du client.

Réponseimage
GET /clients/:id/apercu/portraits/:messageId Owner et Admin

L’aperçu : le portrait de l’auteur d’un message, tel que le client le voit.

Réponseimage
GET /clients/:id/apercu/studio Owner et Admin

L’aperçu : les créations envoyées au portail de ce client.

RéponsePortailCreationDto[]
GET /clients/:id/apercu/studio/:sid Owner et Admin

L’aperçu : une création envoyée, telle que le client la voit (sans ouvrir sa consultation).

RéponsePortailCreationDetailDto (consultable: false)
GET /clients/:id/apercu/studio/:sid/versions/:n/vignette Owner et Admin

L’aperçu : la vignette d’une version envoyée.

Réponseimage
GET /clients/:id/apercu/studio/:sid/versions/:n/fichier Owner et Admin

L’aperçu : le fichier d’une version envoyée, en pièce jointe.

Réponseoctets
GET /clients/:id/apercu/documentation Owner et Admin

L’aperçu : le sommaire de la documentation publiée pour ce client.

RéponsePortailDocEntreeDto[]
GET /clients/:id/apercu/documentation/:slug Owner et Admin

L’aperçu : une page de documentation telle que le client la lit.

RéponsePortailDocPageDto
GET /clients/:id/apercu/documentation/images/:imageId Owner et Admin

L’aperçu : une capture d’une page de documentation.

Réponseimage