L’API On-Premises ne sera bientôt plus disponible. Consultez notre document Abandon progressif de l’API On-Premises pour de plus amples détails, mais aussi pour connaître la procédure de migration vers notre API Cloud nouvelle génération.
Paramètres de profil professionnel
/v1/settings/business/profile
Utilisez le point de terminaison /v1/settings/business/profile pour configurer vos paramètres de profil professionnel suivants : adresse professionnelle, description de l’entreprise, adresse e-mail professionnelle, secteur d’activité et site web de l’entreprise.
Avant de commencer
- Vous devez utiliser le compte
adminpour accéder aux paramètres du profil professionnel.
Récupération
Effectuez un appel d’API GET pour récupérer vos paramètres de profil professionnel.
Exemple
GET /v1/settings/business/profile
Une réponse positive inclut l’objet profile contenant les données du profil professionnel. Pour une description plus détaillée des données, reportez-vous à la liste des paramètres ci-dessous.
{
"settings": {
"business": {
"profile": {
"address": "new-business-address",
"description": "business-description",
"email": "new-business-email",
"vertical": "business-industry",
"websites": [ "website-1", "website-2" ]
}
}
}
Si une erreur se produit, consultez les messages d’erreur et de statut.
Mise à jour des paramètres du profil professionnel
Effectuez un appel d’API POST pour mettre à jour vos paramètres de profil professionnel.
Exemple
POST /v1/settings/business/profile
{
"address": "your-business-address",
"description": "your-business-description",
"email": "your-business-email",
"vertical": "your-business-industry",
"websites": [ "your-website-1", "your-website-2" ]
}
Paramètres
| Nom | Description |
|---|---|
type : chaîne | Adresse de l’entreprise. 256 caractères maximum. |
type : chaîne | Description de l’entreprise. 512 caractères maximum. |
type : chaîne | Adresse e-mail (format d’adresse e-mail valide) du contact professionnel. 128 caractères maximum. |
type : chaîne | Secteur d’activité de l’entreprise. Doit être l’une des valeurs acceptées suivantes :
Une fois créé, le secteur associé à l’entreprise ne peut pas être redéfini sur une valeur vide. |
type : tableau de chaînes | URL (y compris |
Mises à jour partielles
Si vous avez seulement besoin de mettre à jour quelques champs avec de nouvelles informations, vous pouvez faire une requête qui modifie uniquement les champs nécessaires :
POST /v1/settings/business/profile
{
"address": "new-business-address",
"email": "new-business-email"
}
En cas de réussite, la réponse renvoyée comprend le code d’état HTTP 200 OK, et null ou {}. Si une erreur se produit, consultez les messages d’erreur et de statut.