Back to top

Unigest Gmcweb api

Ce document liste l’ensembles des routes disponibles. Il vous servira de guide pour s’authentifier et faire des requetes sur les ressources de votre choix.

Authentification

L’authentification s’effectue à l’aide d’un compte Unigest. Vous devez fournir votre utilisateur et votre mot de passe.

Cet API est sécurisé par un token JWT. Il vous sera fourni lors de votre première connexion. Ce token est valable 24h. Il vous sera renouvelé automatiquement à chaque requête.

Login

Login
POST/login

Action permettant de se connecter à l’API. Elle retourne un token JWT et les informations de l’utilisateur.

Example URI

POST https://api.gmcweb.fr/login
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "username": "<username>",
  "password": "<password>"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "token": "",
  "user": {}
}

Clients

Ressources liés aux clients.

Clients

Clients
GET/clients

Retourne la liste des clients.

Example URI

GET https://api.gmcweb.fr/clients
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer <token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
      "numero_client": string,
      "client": string,
      "civilite": string,
      ...
    },
    {
      "numero_client": string,
      "client": string,
      "civilite": string,
      ...
    },
    {
      "numero_client": string,
      "client": string,
      "civilite": string,
      ...
    },
    ...
  ]

Client

Client
GET/clients/{numero_client}

Retourne les informations d’un client.

Example URI

GET https://api.gmcweb.fr/clients/numero_client
URI Parameters
HideShow
numero_client
number (required) 

Identifiant unique du client

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer <token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "numero_client": string,
    "client": string,
    "civilite": string,
    ...
  }

Contacts

Contacts
GET/clients/{numero_client}/contacts

Retourne la liste des contacts d’un client.

Example URI

GET https://api.gmcweb.fr/clients/numero_client/contacts
URI Parameters
HideShow
numero_client
number (required) 

Identifiant unique du client

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer <token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
      "id": number,
      "numero_client": number,
      "nom": string,
      "fonction": string,
      ...
    },
    ...
  ]

Contact

Contact
GET/clients/contacts/{id}

Retourne les informations d’un contact.

Example URI

GET https://api.gmcweb.fr/clients/contacts/id
URI Parameters
HideShow
id
number (required) 

Identifiant unique du contact

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer <token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "id": number,
    "numero_client": number,
    "nom": string,
    "fonction": string,
    ...
  }

Schemas

utilisateur

{
  id: "number",
  utilisateur: "string",
  email: "string",
  administrateur: "boolean",
  nroclient: "number",
  idclient: "number",
  dbclient: "string",
  nrosociete: "number",
  hierarchie: "number",
  service: "string",
  groupe: "number",
  valide: "boolean",
  page_accueil: "string",
  nom_utilisateur: "string",
  date_creation: "Date",
  derniere_connexion: "Date",
  souscrit: "boolean",
  intervenant: "string",
  raison_bloquage: "string",
  date_bloquage: "Date",
  date_fin: "Date",
  modemini: "boolean",
  utilisateur_bloque: "boolean",
  id_intervenant: "number",
  site: "string",
  page_demarrage: "string",
  db_tiers: "string",
  my_idtiers: "number",
  formule_commerciale: "number",
  langue: "string",
  societe: "string",
  pass_personnel: "boolean",
  sessionid: "number",
  registre: "boolean",
  securite: "boolean",
  environnement: "boolean",
  gmao: "boolean",
  administration: "boolean",
  mobile_enattente_perso: "boolean",
  idholding: "number",
  type_acces: "string",
  id_commercial: "number",
  surveiller_compte: "boolean",
  id_equipement: "number",
  serveur: "string",
  id_responsable: "number",
  full_service: "boolean"
}

Client

{
  numero_client: "number",
  client: "string",
  civilite: "string",
  contact: "string",
  prenom: "string",
  adresse1: "string",
  codepostal: "string",
  bp: "string",
  ville: "string",
  pays: "string",
  telephone: "string",
  telephone2: "string",
  mobile: "string",
  telecopie: "string",
  email: "string",
  activite: "string",
  site_web: "string",
  remise_client: "number",
  date_creation: "Date",
  adresse_livraison: "number",
  adresse_facturation: "number",
  notes: "string",
  delai_reglement: "string",
  mode_paiement: "string",
  commercial: "string",
  nro_intra_client: "string",
  ne_plus_afficher: "boolean",
  code_compta: "string",
  acces_client: "string",
  date_contact: "Date",
  rg: "number",
  code_banque: "string",
  code_guichet: "string",
  numero_compte: "string",
  cle_rib: "string",
  client_comptoir: "boolean",
  adresse2: "string",
  nrosociete: "number",
  idcont1: "number",
  tva_defaut: "number",
  code_client: "string",
  telephone_urgence: "string",
  desabonne_email: "boolean",
  attestation_tva: "boolean",
  siren: "string",
  missionneur: "boolean",
  offre_souscription: "string",
  souscription_date: "Date",
  zone: "string",
  idclient: "number",
  nombre_equipement: "number",
  langue: "string",
  equipements_internes: "boolean",
  codeclient: "string",
  autoliquidation: "boolean",
  utiliser_tva_defaut: "boolean",
  prospect: "boolean",
  preneur_adresse: "string",
  origine: "string",
  id_convention: "number",
  compte_surveille: "boolean",
  site: "string",
  id_mention_perso: "number",
  saas: "boolean",
  id_intervenant: "number",
  email_comptabilite: "string",
  temp: "boolean",
  tarif: "string",
  id_parent: "number",
  info_speciale_adresse: "string",
  devise_client: "string",
  date_modification: "Date",
  modifie_par: "string",
  createur: "string"
}

Contact

{
  id: "number",
  numero_client: "number",
  nom: "string",
  fonction: "string",
  service: "string",
  telephone: "string",
  mobile: "string",
  telecopie: "string",
  email: "string",
  destdoc: "string",
  nrosociete: "number",
  createur: "string"
  date_creation: "Date"
  modifie_par: "string"
  date_modification: "Date"
}

Generated by aglio on 14 Dec 2022