Table of Contents

Création et modification d'une personne de l'annuaire

Ce scénario illustre comment créer une nouvelle personne dans l'annuaire Cegid Expert, puis comment modifier certaines de ses informations.

Processus global

Le processus de création et de modification d'une personne dans l'annuaire Cegid Expert se déroule en plusieurs étapes.

  1. Vérifier l'existence de la personne
  2. Créer la personne si elle n'existe pas
  3. Modifier les informations de la personne si nécessaire

Optionnellement, si la personne n'est pas française, il est recommandé de récupérer la liste des pays disponibles avant de créer la personne.

flowchart LR
A((Début)):::step --> B[ViewAnnuariesUsingFilters]
B--> C{Existe}
C -->|Oui| G
C -->|Non| D
D{Française}
D -->|Oui| F
D -->|Non| E[GetallCountries] --> F
F[CreateAnnuary] --> G
G[/Id/]:::result
G --> H[UpdateSingleAnnuary] --> I((Fin)):::step
classDef default fill:#ffffff,color:#0046ff,stroke:#0046ff
classDef result fill:#0046ff,color:#ffffff,stroke:#0046ff
classDef step fill:#ffffff,color:#FF5C35,stroke:#FF5C35

Étape 1 : Vérifier l'existence de la personne

La première étape consiste à vérifier si la personne que vous souhaitez créer existe déjà dans l'annuaire.

Note

Cette étape peut être omise si vous êtes certain que la personne n'existe pas.

Utiliser l'API de consultation de l'annuaire.
Il s'agit de la méthode ViewAnnuariesUsingFilters de l'API AnnuaryConsultationWebService.

Cette méthode permet de rechercher des personnes dans l'annuaire en utilisant des filtres.
La recherche se fait idéalement via l'email de la personne ou via son SIREN, car ces informations sont uniques.

Ci-dessous, un exemple de corps de requête JSON pour rechercher une personne par son email.

{
 "Page": { "PageIndex": 1, "PageSize": 10 },
 "Filters": [{ "property": 3, "constantValue": "jdoe@gmail.com", "comparisonOperateur": 1, "inversion": false,"logicOperator": 1 }]
}

Si la personne existe, l'API retournera, entre autres, son identifiant unique.
Le retour avec la requête effectuée ressemblera à ceci :

{
   "page": {
       "pageCount": 1
   },
   "annuaries": [
       {
           "id": "153913ab-1022-4e02-9912-d99fbe6f1248",
           "shortName": "JOHN DOE"
       }
   ]
}

Ici, la personne existe déjà et son identifiant est 153913ab-1022-4e02-9912-d99fbe6f1248.

Si aucune personne ne correspond aux filtres de recherche, la liste des personnes de l'annuaire sera vide :

{
	"page": {
		"pageCount": 0
	},
	"annuaries": []
}
Important

Ce n'est pas parce que la liste est vide que la personne n'existe pas.
Pour vous assurer de retrouver une personne dans l'annuaire, veillez à toujours renseigner une information qui permet de la retrouver facilement.
Le mail ou le SIREN étant uniques, il est conseillé de renseigner ces informations.

Note

Pour plus de précisions, veuillez consulter la documentation spécifique à cette API.
https://developers.cegid.com/api-details#api=cpa-expert-coresalesadministration&operation=AnnuaryConsultation-post-annuaryconsultationwebservice-viewannuariesusingfilters

Etape 2 : Récupérer la liste des pays (optionnel)

Si la personne que vous souhaitez créer n'est pas française, il est recommandé de récupérer la liste des pays disponibles.

Note

Cette étape peut être omise si la personne existe déjà et que vous ne prévoyez pas de modifier son pays.

Utiliser l'API de consultation des pays. Il s'agit de la méthode GetAllCountries de l'API CountryConsultationWebService.

Cette méthode s'appelle sans paramètre et retourne la liste complète des pays.
Elle n'a besoin d'aucun paramètre et d'aucun corps.

Le retour ressemblera à ceci.
Il a été volontairement tronqué pour ne pas surcharger cette documentation.

{
   "countries": [
       {
           "id": "AD ",
           "name": "ANDORRE"
       },
       {
           "id": "BRA",
           "name": "BRESIL"
       },
       {
           "id": "FRA",
           "name": "FRANCE"
       },
       {
           "id": "USA",
           "name": "ETATS UNIS D'AMERIQUE"
       },
       {
           "id": "ZWE",
           "name": "ZIMBABWE"
       }
   ]
}

Si vous souhaitez créer une personne résidant aux États-Unis, vous devrez utiliser l'identifiant USA dans le champ correspondant lors de la création de la personne.

Étape 3 : Créer une nouvelle personne

Pour créer une nouvelle personne, vous devez utiliser l'API de création de personne.

Note

Cette étape peut être omise si la personne existe déjà.

Il s'agit de la méthode CreateAnnuary de l'API AnnuaryInsertionWebService.

Cette méthode demandera obligatoirement le type de personne à créer (1 = personne morale, 2 = personne physique) ainsi que sa raison sociale pour une personne morale ou son nom pour une personne physique.

Le JSON ci-dessous a servi à la création de la fiche annuaire de John Doe, recherchée à l'étape 1 :

{
 "identityType": 2,
 "shortName": "JOHN DOE",
 "physicalPerson": {
   "lastName": "Doe",
   "firstName": "John"
 },
 "countryCode": "USA"
}
Note

IdentityType est à 2 car il s'agit d'une personne physique.
JuridicalPerson n'est pas renseigné.
PhysicalPerson est renseigné avec le nom et le prénom de la personne.
CountryCode est à USA car John Doe réside aux États-Unis.

Le JSON ci-dessous permet de créer la fiche annuaire d'une société nommée "CEGID" :

{
 "identityType": 1,
 "shortName": "CEGID",
 "juridicalPerson": {
   "corporateName1": "CEGID",
   "corporateName2": ""
 }
}
Note

IdentityType est à 1 car il s'agit d'une personne morale.
JuridicalPerson est renseigné avec les parties 1 et 2 de la raison sociale.
PhysicalPerson n'est pas renseigné.
CountryCode n'est pas renseigné, car FRA est placé par défaut.

Le retour est l'identifiant unique de la personne créée :
"1F3B36F9-5F2A-4314-B1B6-5DBE7B75A5AB"

Note

Cet identifiant devra être utilisé pour toute modification des données concernant CEGID.

Étape 4 : Modifier les informations de la personne

Une fois la personne créée, vous pouvez modifier ses informations si nécessaire.
Pour cela, utilisez l'API de mise à jour des personnes de l'annuaire.
Il s'agit de la méthode UpdateSingleAnnuary de l'API AnnuaryModificationWebService.

Important

Veuillez vous référer aux principes de mise à jour des données afin d'éviter de faire des erreurs lors de l'appel à cette méthode.

Le JSON ci-dessous va modifier les données légales, l'adresse et les données de communication de la société CEGID créée à l'étape précédente :

{
   "id": "1F3B36F9-5F2A-4314-B1B6-5DBE7B75A5AB",
   "juridicalPerson": {
       "shortName": "CEGID",
       "corporateName1": "CEGID",
       "corporateName2": "",
       "legalForm": "SAS",
       "siren": "410 218 010",
       "nic": "00032",
       "inseeCode": "",
       "naf": "6311Z"
   },
   "legalAddress": {
       "streetNumber": "52",
       "streetNumberPrecision": 0,
       "streetType": "QUA",
       "streetName": "Paul Sédaillan",
       "address1": "",
       "address2": "",
       "address3": "",
       "zipCode": "69009",
       "city": "LYON",
       "country": "FRA",
       "residence": "",
       "building": "",
       "stair": "",
       "floor": "",
       "apartmentNumber": ""
   },
   "communication": {
       "phone1": "0800730079",
       "phone2": "0429295000",
       "phone3": "",
       "email": "",
       "webSite": "https://www.cegid.com/fr/"
   }
}
Note

Pour plus de précisions, veuillez consulter la documentation spécifique à cette API.
https://developers.cegid.com/api-details#api=cpa-expert-coresalesadministration&operation=AnnuaryModification-post-annuarymodificationwebservice-updatesingleannuary