curl --request GET \
--url https://api.avest.fr/v1/external-integration/user \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.avest.fr/v1/external-integration/user"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.avest.fr/v1/external-integration/user', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.avest.fr/v1/external-integration/user",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.avest.fr/v1/external-integration/user"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.avest.fr/v1/external-integration/user")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avest.fr/v1/external-integration/user")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"user": {
"id": "618a35a36d932054e195ca0a",
"firstName": "Thomas",
"lastName": "Godard",
"phone": "+33612345678",
"picture": "https://static.example.com/user/618a35a36d932054e195ca0a.jpg",
"jobTitle": "Directeur",
"agentStatus": "independent",
"agentRegistrationNumber": "CPI 3101 2020 000 012 345"
}
}Récupérer un collaborateur par identifiant
Récupère un utilisateur (collaborateur) par son identifiant. Pratique pour résoudre un owner (présent sur les ventes, acquisitions, locations et contacts) en nom, prénom et photo.
id est obligatoire et doit être un identifiant valide → sinon 400. Toute clé de query non listée → 400. Un utilisateur hors périmètre autorisé retourne user: null. Les champs optionnels sont omis lorsqu’ils ne sont pas renseignés.
Bonne pratique : ne pas appeler cette route en boucle pour résoudre chaque owner ; récupérer plutôt l’annuaire complet une seule fois via /external-integration/users et le mettre en cache. Endpoint en lecture seule.
curl --request GET \
--url https://api.avest.fr/v1/external-integration/user \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.avest.fr/v1/external-integration/user"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.avest.fr/v1/external-integration/user', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.avest.fr/v1/external-integration/user",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.avest.fr/v1/external-integration/user"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.avest.fr/v1/external-integration/user")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avest.fr/v1/external-integration/user")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"user": {
"id": "618a35a36d932054e195ca0a",
"firstName": "Thomas",
"lastName": "Godard",
"phone": "+33612345678",
"picture": "https://static.example.com/user/618a35a36d932054e195ca0a.jpg",
"jobTitle": "Directeur",
"agentStatus": "independent",
"agentRegistrationNumber": "CPI 3101 2020 000 012 345"
}
}Autorisations
Token LinkedAPI avec scope externalIntegration. La clé doit avoir un agencyGroup configuré (sinon 400 LinkedAPI agencyGroup is required). Fourni via l'en-tête Authorization: Bearer {linkedAPI_token}. Si la clé a secure === true, l'IP appelante doit être whitelistée (en-tête X-Real-IP), sinon 403 Not authorized to access this resource.
La clé porte aussi un niveau d'accès : en lecture seule, elle n'autorise que les GET ; un POST ou un PATCH renvoie alors 403 Not authorized to access this resource, soit la même réponse qu'une requête sans en-tête Authorization. Voir le guide Authentification.