Aller au contenu principal

Gestion des entreprises

Ce document détaille le fonctionnement et l'utilisation des endpoints pour gérer les entreprises l'application Certificall.

Listing des entreprises​

Endpoint : GET /companies​

Description​

Le endpoint récupère l'entreprise et toute la hiérarchie des entreprises liées

Authentification​

L'accès à ce endpoint nécessite une authentification valide. Incluez un token JWT (JSON Web Token) dans l'en-tête de votre requête HTTP comme suit :

Authorization: Bearer <Votre_Token_JWT>

Requête HTTP​

Méthode : GET URL : /companies

Exemple :

curl -X 'GET' \
'https://admin.certificall.app/certificall/api/companies' \
-H 'accept: application/json' \
-H 'Authorization: Bearer xxxx'

Réponses​

200 OK : Retourne une liste des entreprises avec leur Id, leur nom, l'ID de l'entreprise parente et le niveau de profondeur.

Exemple de réponse :

{
  "descendants": [
    {
      "id": 1,
      "name": "Ent1",
      "parentId": null,
      "niveau": 0
    },
    {
      "id": 2,
      "name": "Ent2",
      "parentId": 1,
      "niveau": 1
    },
    {
      "id": 6,
      "name": "Ent6",
      "parentId": 1,
      "niveau": 1
    }
  ]
}

400 Bad Request : La requête est invalide, généralement en raison de paramètres manquants ou incorrects.

500 Internal Server Error : Erreur interne du serveur empêchant le traitement de la requête.