API des entreprises

🚀 Pourquoi utiliser l’API des entreprises?

Les entreprises sont une entité fondamentale dans DataDocks, représentant les organisations qui interagissent avec vos entrepôts — qu’il s’agisse de transporteurs qui déplacent les marchandises ou de clients qui les envoient ou les reçoivent. L’API des entreprises vous permet de gérer ces relations de façon automatisée, en synchronisant vos données d’entreprises avec vos systèmes ERP, CRM ou tout autre système métier.

Problèmes réels résolus par cette API

Maintenir une source de vérité unique : Synchronisez les données des entreprises entre vos systèmes d’entreprise et DataDocks
Simplifier l’intégration de nouveaux partenaires : Créez automatiquement des fiches transporteurs et clients lors de leur ajout à vos systèmes
Améliorer l’exactitude des données : Gardez à jour les coordonnées et les préférences d’expédition
Automatiser la gestion des relations : Contrôlez de manière programmatique quelles entreprises peuvent interagir entre elles

Démarrage rapide en 5 minutes

Vous voulez voir l’API en action tout de suite? Suivez ces étapes pour créer votre première entreprise :

Obtenez votre jeton API auprès du support
Trouvez votre sous-domaine d’emplacement (ex. : votre-entrepot.datadocks.com)
Créez une entreprise de base avec cette commande :

Voir un exemple cURL

curl -X POST \
  https://your-warehouse.datadocks.com/api/v1/companies \
  -H 'Authorization: Token YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "company": {
      "name": "Acme Logistics",
      "company_type": "carrier",
      "company_number": "ACME-001",
      "email": "dispatch@acmelogistics.example.com",
      "phone": "+15551234567"
    }
  }'

Voilà ! Vous venez de créer votre première entreprise. Vérifiez votre tableau de bord DataDocks pour la voir.

Vue d’ensemble de l’architecture de l’API

┌─────────────────┐       ┌─────────────────┐       ┌─────────────────┐
│  Votre système  │──────▶│   DataDocks API │──────▶│ Opérations entrepôt │
│ (ERP/CRM/TMS)   │◀──────┤   (REST/JSON)   │◀──────┤   (Entreprises) │
└─────────────────┘       └─────────────────┘       └─────────────────┘
                                  │  ▲
                                  │  │
                                  ▼  │
                           ┌─────────────────┐
                           │  Portails       │
                           │  transporteurs  │
                           │  / clients      │
                           └─────────────────┘

Authentification

Toutes les requêtes à l’API doivent inclure votre jeton API dans l’en-tête Authorization :

Authorization: Token YOUR_API_TOKEN

Lister les entreprises

Objectif

Obtenir une liste paginée des entreprises avec filtrage optionnel par type, nom ou numéro d’entreprise. Utilisez ce point d’accès pour synchroniser les entreprises avec vos systèmes ou générer des rapports.

Cas d’usage métier

Synchroniser les entreprises avec votre ERP ou CRM
Générer des rapports sur les transporteurs ou clients
Afficher les informations d’entreprise dans vos tableaux de bord personnalisés
Filtrer les entreprises par type pour des traitements spécialisés

Requête HTTP

GET https://[location_subdomain].datadocks.com/api/v1/companies

Paramètres de requête

Paramètre	Type	Obligatoire	Description	Exemple
`page`	Integer	Non	Numéro de page pour la pagination (par défaut 1)	`page=2`
`company_type`	String	Non	Filtrer par type d’entreprise (insensible à la casse)	`company_type=carrier`
`name`	String	Non	Filtrer par nom d’entreprise (insensible à la casse, débutant)	`name=acme`
`company_number`	String	Non	Filtrer par numéro d’entreprise (insensible à la casse, exact)	`company_number=ACME-001`

Format de la réponse

La réponse contient un tableau paginé d’objets entreprise, avec les champs suivants :

Champ	Type	Description
`id`	Integer	Identifiant unique de l’entreprise
`parent_id`	Integer	ID de la société parente (null si aucune)
`company_type`	String	Type d’entreprise ("carrier", "customer" ou "both")
`name`	String	Nom de l’entreprise
`company_number`	String	Identifiant externe unique de l’entreprise
`email`	String	Adresse courriel principale de l’entreprise
`phone`	String	Numéro de téléphone principal
`street`	String	Adresse civique
`unit`	String	N° de suite/unité
`city`	String	Ville
`province`	String	Province ou État
`country`	String	Code pays (ISO 2 lettres)
`postal`	String	Code postal ou ZIP
`category`	String	Catégorie ou classe
`auto_approve_appointments`	Boolean	Les rendez-vous sont-ils automatiquement approuvés ?
`can_create_carriers`	Boolean	Peut-elle créer d’autres transporteurs ?
`notifications`	Boolean	Reçoit-elle des notifications ?
`custom_values`	Object	Paires clé-valeur de champs personnalisés
`users`	Array	Liste des utilisateurs liés à cette entreprise

Exemples de code

cURL

Voir un exemple cURL

# Liste de base
curl -H "Authorization: Token YOUR_API_TOKEN" \
     https://YOUR_LOCATION.datadocks.com/api/v1/companies

# Filtrer par type d’entreprise et nom
curl -H "Authorization: Token YOUR_API_TOKEN" \
     "https://YOUR_LOCATION.datadocks.com/api/v1/companies?company_type=carrier&name=logistic"

JavaScript

Voir un exemple JavaScript

// Utiliser fetch API avec des filtres
const getCompanies = async (companyType, nameFilter, companyNumber) => {
  const params = new URLSearchParams();
  if (companyType) params.append("company_type", companyType);
  if (nameFilter) params.append("name", nameFilter);
  if (companyNumber) params.append("company_number", companyNumber);

  const response = await fetch(
    `https://YOUR_LOCATION.datadocks.com/api/v1/companies?${params.toString()}`,
    {
      method: "GET",
      headers: {
        Authorization: "Token YOUR_API_TOKEN",
        "Content-Type": "application/json",
      },
    }
  );

  // Gérer les erreurs potentielles
  if (!response.ok) {
    const errorData = await response.json();
    throw new Error(`Échec lors de la récupération des entreprises : ${JSON.stringify(errorData)}`);
  }

  return response.json();
};

Exemple de réponse

Voir un exemple de réponse

[
  {
    "id": 1,
    "parent_id": null,
    "company_type": "carrier",
    "name": "Joe's Shipping",
    "company_number": "A17727959343",
    "email": "info@joesshipping.com",
    "phone": "+14161231234",
    "street": "1 Yonge St.",
    "unit": null,
    "city": "Toronto",
    "province": "ON",
    "country": "CA",
    "postal": "M8H 1G1",
    "category": null,
    "auto_approve_appointments": true,
    "can_create_carriers": false,
    "notifications": true,
    "custom_values": {
      "ap_contact": "Sue Brown",
      "sales_contact": "Tim Jones",
      "facility_contact": "John Green"
    },
    "users": [
      {
        "email": "driver@joesshipping.com",
        "name": "Joe Driver"
      }
    ]
  },
  {
    "id": 2,
    "parent_id": null,
    "company_type": "customer",
    "name": "Spatula City",
    "company_number": "B83582616848",
    "email": "info@spatulacity.com",
    "phone": "+14161231234",
    "street": "1 Yonge St.",
    "unit": "4",
    "city": "Toronto",
    "province": "ON",
    "country": "CA",
    "postal": "M8H 1G1",
    "category": null,
    "auto_approve_appointments": false,
    "can_create_carriers": true,
    "notifications": false,
    "custom_values": {
      "ap_contact": "",
      "sales_contact": "Al Yankovic",
      "facility_contact": ""
    },
    "users": []
  }
]

Pagination

La réponse est paginée pour gérer le volume de données. Pour plus d’informations sur les en-têtes de pagination et la navigation, consultez la documentation sur la pagination.

Obtenir une entreprise spécifique

Objectif

Obtenir les détails d’une entreprise donnée par son ID. Utilisez ce point d’accès quand vous avez besoin de toutes les informations disponibles pour une entreprise particulière.

Cas d’usage métier

Afficher le détail d’une entreprise dans votre application
Vérifier les coordonnées avant de traiter une transaction
Récupérer les infos de contact pour des communications
Accéder aux paramètres spécifiques de l’entreprise

Requête HTTP

GET https://[location_subdomain].datadocks.com/api/v1/companies/:id

Paramètres de chemin

Paramètre	Type	Obligatoire	Description
`id`	Integer	Oui	ID unique de l’entreprise

Réponse

Une requête réussie retourne un code 200 OK avec l’objet entreprise complet, au même format que pour la liste.

Exemples de code

cURL

Voir un exemple cURL

curl -H "Authorization: Token YOUR_API_TOKEN" \
     https://YOUR_LOCATION.datadocks.com/api/v1/companies/123

JavaScript

Voir un exemple JavaScript

const getCompany = async (companyId) => {
  try {
    const response = await fetch(
      `https://YOUR_LOCATION.datadocks.com/api/v1/companies/${companyId}`,
      {
        method: "GET",
        headers: {
          Authorization: "Token YOUR_API_TOKEN",
          "Content-Type": "application/json",
        },
      }
    );

    if (!response.ok) {
      if (response.status === 404) {
        throw new Error(`Entreprise #${companyId} introuvable`);
      }

      const errorData = await response.json();
      throw new Error(
        `Échec lors de la récupération de l’entreprise : ${JSON.stringify(errorData)}`
      );
    }

    return await response.json();
  } catch (error) {
    console.error("Erreur lors de la récupération de l’entreprise :", error);
    throw error;
  }
};

Créer une entreprise

Objectif

Créer un nouvel enregistrement d’entreprise dans DataDocks. Cet endpoint vous permet d’ajouter de nouveaux transporteurs ou clients de façon automatisée.

Arbre de décision : Quand créer une entreprise via l’API ?

┌─────────────────┐
│ Faut-il ajouter │
│  une entreprise?│
└────────┬────────┘
         │
         ▼
┌─────────────────┐     Oui      ┌─────────────────┐
│ Plusieurs à     │─────────────▶│  Utilisez le    │
│ ajouter en même │              │  chargement en  │
│     temps?      │              │      vrac       │
└────────┬────────┘              └─────────────────┘
         │ Non
         ▼
┌─────────────────┐     Oui      ┌─────────────────┐
│ Un ajout unique │─────────────▶│  Passez par     │
│   / occasionnel?│              │ l’interface web │
└────────┬────────┘              └─────────────────┘
         │ Non
         ▼
┌─────────────────┐
│ Parfait pour    │
│ l’API !         │
└─────────────────┘

Cas d’usage métier

Intégration système : Créez des entreprises directement depuis votre ERP ou CRM
Automatiser l’intégration : Ajoutez de nouveaux transporteurs/clients automatiquement
Migration de données : Transférez des fiches depuis vos anciens systèmes
Intégration partenaires : Permettez à vos partenaires d’inscrire leur entreprise via vos systèmes

Requête HTTP

POST https://[location_subdomain].datadocks.com/api/v1/companies

Corps de la requête

Paramètre	Type	Obligatoire	Description	Contraintes	Par défaut	Exemple
`name`	String	Oui	Nom de l’entreprise	2-164 caractères, unique dans l’org (casse insens.)	Aucune	`"Acme Logistics"`
`company_type`	String	Oui	Type d’entreprise	"carrier", "customer" ou "both"	Aucune	`"carrier"`
`company_number`	String	Non	Identifiant externe	Unique dans org	Numéro 11 chiffres auto	`"ACME-001"`
`email`	String	Non	Adresse courriel principale	Format courriel valide, 4-128 caractères	Aucune	`"info@example.com"`
`phone`	String	Non	Numéro de téléphone principal	Aucune	Aucune	`"+15551234567"`
`street`	String	Non	Adresse civique	4-64 caractères si présent	Aucune	`"123 Main St"`
`unit`	String	Non	N° de suite/unité	1-64 caractères si présent	Aucune	`"Suite 400"`
`city`	String	Non	Ville	2-64 caractères si présent	Aucune	`"Chicago"`
`province`	String	Non	Province ou État	Aucune	Aucune	`"IL"`
`country`	String	Non	Code pays	2 lettres si fourni (code ISO)	Aucune	`"US"`
`postal`	String	Non	Code postal ou ZIP	4-10 caractères si présent	Aucune	`"60601"`
`category`	String	Non	Catégorie ou classe	Aucune	Aucune	`"Premium"`
`auto_approve_appointments`	Boolean	Non	Approuve-t-elle auto. les rendez-vous	Aucune	`false`	`true`
`can_create_carriers`	Boolean	Non	Peut-elle créer des transporteurs	Aucune	`false`	`false`
`notifications`	Boolean	Non	Reçoit-elle des notifications	Aucune	`false`	`true`
`can_book_drop_trailers`	Boolean	Non	Peut réserver des remorques à déposer	Aucune	`true`	`true`
`send_appointment_no_show_notifications`	Boolean	Non	Envoie des notifs «no show»	Aucune	`true`	`true`
`send_appointment_late_notifications`	Boolean	Non	Envoie des notifs de retard	Aucune	`true`	`true`
`custom_values`	Object	Non	Valeurs champs personnalisés	Selon les paramètres de l’emplacement	`{}`	`{"reference": "ABC123"}`
`invite_user`	String	Non	Inviter un utilisateur lié	Si "true", utilise le champ courriel	`false`	`"true"`
`parent_id`	Integer	Non	ID entreprise parente	Doit exister	Aucune	`123`

Réponse

Un succès retourne 200 OK avec l’objet entreprise complet, incluant son id et autres valeurs générées par le système.

Exemples de code

cURL

Voir un exemple cURL

curl -H "Authorization: Token YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{
       "company": {
         "name": "Quick Transport Inc",
         "company_type": "carrier",
         "company_number": "QT-2023-001",
         "email": "dispatch@quicktransport.example.com",
         "phone": "+15551234567",
         "street": "123 Logistics Way",
         "city": "Chicago",
         "province": "IL",
         "country": "US",
         "postal": "60601",
         "auto_approve_appointments": true,
         "notifications": true,
         "custom_values": {
           "insurance_policy": "INS-567890",
           "preferred_dock": "Dock 3"
         },
         "invite_user": "true",
         "parent_id": 123
       }
     }' \
     https://YOUR_LOCATION.datadocks.com/api/v1/companies

JavaScript

Voir un exemple JavaScript

const createCompany = async (companyData) => {
  try {
    const response = await fetch(
      `https://YOUR_LOCATION.datadocks.com/api/v1/companies`,
      {
        method: "POST",
        headers: {
          Authorization: "Token YOUR_API_TOKEN",
          "Content-Type": "application/json",
        },
        body: JSON.stringify({ company: companyData }),
      }
    );

    if (!response.ok) {
      const errorData = await response.json();
      const errorMessages = Object.entries(errorData.errors || {})
        .map(([field, messages]) => `${field}: ${messages.join(", ")}`)
        .join("\n");

      throw new Error(`Échec de la création de l’entreprise :\n${errorMessages}`);
    }

    return await response.json();
  } catch (error) {
    console.error("Erreur API :", error);
    throw error;
  }
};

Mettre à jour une entreprise

Objectif

Mettre à jour les informations d’une entreprise existante. Cet endpoint vous permet de modifier tout aspect d’une fiche entreprise.

Cas d’usage métier

Garder les données à jour : Modifiez coordonnées ou préférences logistiques
Changer l’état de l’entreprise : Modifiez les paramètres de notification ou d’approbation automatique des rendez-vous
Gérer les permissions : Ajustez ce que l’entreprise peut faire dans le système
Synchroniser les systèmes : Gardez DataDocks aligné avec votre ERP/CRM

Requête HTTP

PUT https://[location_subdomain].datadocks.com/api/v1/companies/:id

Paramètres de chemin

Paramètre	Type	Obligatoire	Description
`id`	Integer	Oui	ID unique de l’entreprise

Corps de la requête

Le corps accepte les mêmes paramètres que pour la création. Seuls les champs à modifier doivent être inclus.

Scénarios courants de mise à jour

Mettre à jour les coordonnées

{
  "company": {
    "email": "new-contact@example.com",
    "phone": "+15559876543"
  }
}

Modifier les notifications

{
  "company": {
    "notifications": true,
    "auto_approve_appointments": false
  }
}

Mettre à jour l’adresse

{
  "company": {
    "street": "456 New Street",
    "city": "New City",
    "province": "NC",
    "postal": "90210"
  }
}

Exemples de code

cURL

Voir un exemple cURL

curl -H "Authorization: Token YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -X PUT \
     -d '{
       "company": {
         "name": "Updated Company Name",
         "email": "newemail@example.com",
         "custom_values": {
           "account_manager": "Jane Smith"
         }
       }
     }' \
     https://YOUR_LOCATION.datadocks.com/api/v1/companies/123

JavaScript

Voir un exemple JavaScript

const updateCompany = async (companyId, updateData) => {
  try {
    const response = await fetch(
      `https://YOUR_LOCATION.datadocks.com/api/v1/companies/${companyId}`,
      {
        method: "PUT",
        headers: {
          Authorization: "Token YOUR_API_TOKEN",
          "Content-Type": "application/json",
        },
        body: JSON.stringify({ company: updateData }),
      }
    );

    if (!response.ok) {
      const errorData = await response.json();
      throw new Error(`Échec de la mise à jour de l’entreprise : ${JSON.stringify(errorData)}`);
    }

    return await response.json();
  } catch (error) {
    console.error("Erreur lors de la mise à jour de l’entreprise :", error);
    throw error;
  }
};

// Exemple d’utilisation
const updateCompanyEmail = async (companyId, newEmail) => {
  try {
    const updatedCompany = await updateCompany(companyId, {
      email: newEmail,
    });

    console.log(`Mise à jour du courriel pour l’entreprise #${updatedCompany.id} réussie`);
    return updatedCompany;
  } catch (error) {
    console.error(`Échec de la mise à jour de l’entreprise #${companyId} :`, error);
    throw error;
  }
};

Gestion des erreurs

Code erreur	Description	Cause possible
400	Requête invalide	Valeurs ou format incorrects
404	Introuvable	L’ID entreprise n’existe pas
422	Entité non traitable	Validation échouée (ex : nom en doublon)
401	Non autorisé	Jeton API manquant ou invalide
403	Interdit	Permissions insuffisantes

Supprimer une entreprise

Objectif

Supprimer une entreprise du système. Ce point d’accès permet d’effacer les entreprises devenues inutiles.

Points importants à considérer

Avant de supprimer une entreprise :

L’entreprise ne doit pas avoir de rendez-vous actifs
L’entreprise ne doit pas être liée à des listes d’emballage actives
La suppression est définitive et irréversible

Cas d’usage métier

Nettoyer les données de test : Supprimez les entreprises de tests
Respecter les demandes de confidentialité : Effacez les infos sur demande
Effacer les doublons : Nettoyez après déduplication des données
Entretien système : Retirez les entreprises inactives

Requête HTTP

DELETE https://[location_subdomain].datadocks.com/api/v1/companies/:id

Paramètres de chemin

Paramètre	Type	Obligatoire	Description
`id`	Integer	Oui	ID unique de l’entreprise

Réponse

Le succès retourne une réponse 204 No Content, indiquant que l’entreprise a bien été supprimée.

Exemples de code

cURL

Voir un exemple cURL

curl -H "Authorization: Token YOUR_API_TOKEN" \
     -X DELETE \
     https://YOUR_LOCATION.datadocks.com/api/v1/companies/123

JavaScript

Voir un exemple JavaScript

const deleteCompany = async (companyId) => {
  try {
    const response = await fetch(
      `https://YOUR_LOCATION.datadocks.com/api/v1/companies/${companyId}`,
      {
        method: "DELETE",
        headers: {
          Authorization: "Token YOUR_API_TOKEN",
        },
      }
    );

    if (!response.ok) {
      if (response.status === 404) {
        throw new Error(`Entreprise #${companyId} introuvable`);
      }

      const errorData = await response.json();
      throw new Error(`Échec lors de la suppression : ${JSON.stringify(errorData)}`);
    }

    return true; // Suppression réussie
  } catch (error) {
    console.error("Erreur de suppression :", error);
    throw error;
  }
};

Gestion des erreurs

Code erreur	Description	Cause possible
404	Introuvable	L’ID entreprise n’existe pas
401	Non autorisé	Jeton API manquant ou invalide
403	Interdit	Permissions insuffisantes pour la suppression
422	Entité non traitable	Impossible de supprimer (ex : associés à des rendez-vous ou listes)

Règles de validation des champs

Pour la création/mise à jour d’entreprises, ces règles s’appliquent :

Champ	Règles de validation
`name`	Obligatoire, 2-164 caractères, unique dans l’org (insensible casse)
`company_type`	Obligatoire, "carrier", "customer" ou "both"
`company_number`	Facultatif, unique dans org
`email`	Facultatif, format courriel valide, 4-128 caractères
`street`	Facultatif, 4-64 caractères si fourni
`unit`	Facultatif, 1-64 caractères si fourni
`city`	Facultatif, 2-64 caractères si fourni
`country`	Facultatif, exactement 2 lettres si fourni (code ISO)
`postal`	Facultatif, 4-10 caractères si fourni

Invitation automatique d’un utilisateur

Lors de la création/mise à jour d’une entreprise, vous pouvez automatiquement inviter un utilisateur associé en passant le paramètre invite_user à "true", "yes", "y" ou "t" (casse insensible).

Le système :

Crée un utilisateur associé à l’entreprise avec l’adresse courriel de l’entreprise
Envoie une invitation par courriel à cette adresse
L’utilisateur pourra alors créer son compte et accéder à l’entreprise dans DataDocks

Exemple :

{
  "company": {
    "name": "New Carrier Inc",
    "company_type": "carrier",
    "email": "dispatch@newcarrier.example.com",
    "invite_user": "true"
  }
}

Bonnes pratiques

Gestion des données

Utilisez des identifiants cohérents : Gardez le numéro d’entreprise aligné dans tous vos systèmes
Validez côté client : Vérifiez les données avant l’envoi pour respecter les validations
Gérez bien les champs personnalisés : Utilisez seulement ceux prévus par votre emplacement
Attention à la suppression : Préférez la mise à jour quand pertinent
Invitez uniquement les bons utilisateurs : L’accès système doit être justifié

Optimisation des performances

Effectuez des mises à jour en lot : Groupez les modifications similaires
Utilisez la pagination : Ne demandez que les entreprises dont vous avez besoin
Filtrez efficacement : Utilisez les filtres existants pour limiter le volume de données
Mettez en cache les recherches fréquentes : Stockez localement ce qui est souvent consulté

Pièges courants et dépannage

Nom unique : Les noms doivent être uniques dans l’organisation (insensible à la casse)
Format courriel : Les adresses doivent respecter le format et la longueur
Valeurs personnalisées : Seuls les champs autorisés pour l’emplacement sont acceptés
Types d’entreprise : Seules "carrier", "customer" ou "both" sont valides
Numéro d’entreprise automatique : Il est généré si non fourni (jusqu’à 11 chiffres)
Code pays : Obligatoire au format ISO 2 lettres (ex : "US", "CA", "MX")
Entreprises parentes : Le parent doit exister; les permissions sont créées automatiquement
Casse : Les filtres sont insensibles à la casse, tout comme la validation interne

Aide et support

Si vous rencontrez un problème non couvert par cette documentation :

Vérifiez la réponse d’erreur : la majorité des défauts comporte des infos explicites
Vérifiez vos permissions : assurez-vous que votre jeton API a les droits requis
Avancez par étapes : décomposez vos opérations pour isoler le souci

Relation parent-enfant entre entreprises

Quand vous créez une entreprise avec une société parente (parent_id), le lien parent-enfant est automatiquement créé. Cela signifie :

L’entreprise “enfant” est liée à la parente via le champ parent_id
Les permissions de réservation sont générées automatiquement dans les deux sens
- La société parente peut effectuer des réservations pour l’enfant
- L’enfant peut réserver pour la parente

Cela simplifie la gestion des groupes d’entreprises : elles peuvent interagir immédiatement, sans autre configuration.

Exemple de création d’une filiale :

{
  "company": {
    "name": "Northeast Branch",
    "company_type": "carrier",
    "parent_id": 123,
    "email": "northeast@example.com"
  }
}

🚀 Pourquoi utiliser l’API des entreprises?​

Problèmes réels résolus par cette API​

Démarrage rapide en 5 minutes​

Vue d’ensemble de l’architecture de l’API​

Authentification​

Lister les entreprises​

Objectif​

Cas d’usage métier​

Requête HTTP​

Paramètres de requête​

Format de la réponse​

Exemples de code​

cURL​

JavaScript​

Exemple de réponse​

Pagination​

Obtenir une entreprise spécifique​

Objectif​

Cas d’usage métier​

Requête HTTP​

Paramètres de chemin​

Réponse​

Exemples de code​

cURL​

JavaScript​

Créer une entreprise​

Objectif​

Arbre de décision : Quand créer une entreprise via l’API ?​

Cas d’usage métier​

Requête HTTP​

Corps de la requête​

Réponse​

Exemples de code​

cURL​

JavaScript​

Mettre à jour une entreprise​

Objectif​

Cas d’usage métier​

Requête HTTP​

Paramètres de chemin​

Corps de la requête​

Scénarios courants de mise à jour​

Mettre à jour les coordonnées​

Modifier les notifications​

Mettre à jour l’adresse​

Exemples de code​

cURL​

JavaScript​

Gestion des erreurs​

Supprimer une entreprise​

Objectif​

Points importants à considérer​

Cas d’usage métier​

Requête HTTP​

Paramètres de chemin​

Réponse​

Exemples de code​

cURL​

JavaScript​

Gestion des erreurs​

Règles de validation des champs​

Invitation automatique d’un utilisateur​

Bonnes pratiques​

Gestion des données​

Optimisation des performances​

Pièges courants et dépannage​

Aide et support​

Relation parent-enfant entre entreprises​

🚀 Pourquoi utiliser l’API des entreprises?

Problèmes réels résolus par cette API

Démarrage rapide en 5 minutes

Vue d’ensemble de l’architecture de l’API

Authentification

Lister les entreprises

Objectif

Cas d’usage métier

Requête HTTP

Paramètres de requête

Format de la réponse

Exemples de code

cURL

JavaScript

Exemple de réponse

Pagination

Obtenir une entreprise spécifique

Objectif

Cas d’usage métier

Requête HTTP

Paramètres de chemin

Réponse

Exemples de code

cURL

JavaScript

Créer une entreprise

Objectif

Arbre de décision : Quand créer une entreprise via l’API ?

Cas d’usage métier

Requête HTTP

Corps de la requête

Réponse

Exemples de code

cURL

JavaScript

Mettre à jour une entreprise

Objectif

Cas d’usage métier

Requête HTTP

Paramètres de chemin

Corps de la requête

Scénarios courants de mise à jour

Mettre à jour les coordonnées

Modifier les notifications

Mettre à jour l’adresse

Exemples de code

cURL

JavaScript

Gestion des erreurs

Supprimer une entreprise

Objectif

Points importants à considérer

Cas d’usage métier

Requête HTTP

Paramètres de chemin

Réponse

Exemples de code

cURL

JavaScript

Gestion des erreurs

Règles de validation des champs

Invitation automatique d’un utilisateur

Bonnes pratiques

Gestion des données

Optimisation des performances

Pièges courants et dépannage

Aide et support

Relation parent-enfant entre entreprises