cURL
curl --request GET \
--url https://flatbay.fr/fr/api/user/optin/{id}import requests
url = "https://flatbay.fr/fr/api/user/optin/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://flatbay.fr/fr/api/user/optin/{id}', 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://flatbay.fr/fr/api/user/optin/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://flatbay.fr/fr/api/user/optin/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://flatbay.fr/fr/api/user/optin/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flatbay.fr/fr/api/user/optin/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": "ok"
}{
"error": "<string>"
}{
"error": "<string>"
}Endpoint Examples
Optin Utilisateur
Route de gestion de l’optin d’un utilisateur. Permet d’activer ou de désactiver l’optin pour un utilisateur sur tous les établissements du groupe.
GET
/
user
/
optin
/
{id}
cURL
curl --request GET \
--url https://flatbay.fr/fr/api/user/optin/{id}import requests
url = "https://flatbay.fr/fr/api/user/optin/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://flatbay.fr/fr/api/user/optin/{id}', 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://flatbay.fr/fr/api/user/optin/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://flatbay.fr/fr/api/user/optin/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://flatbay.fr/fr/api/user/optin/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flatbay.fr/fr/api/user/optin/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": "ok"
}{
"error": "<string>"
}{
"error": "<string>"
}/api/user/optin/:id?apiKey=xxxxx
Comportement
- Si le paramètre
optina la valeuroptin, l’optin est activé pour l’utilisateur - Sinon, l’optin est désactivé
Exemple d’utilisation
Activer l’optin:GET /api/user/optin/123?apiKey=xxxxx&optin=optin
GET /api/user/optin/123?apiKey=xxxxx
Codes d’erreur
| Code | Description |
|---|---|
| BADPARAMS | userId manquant |
| NOAPIKEY | Clé API manquante |
| USERNOTINGROUP | L’utilisateur n’appartient pas à votre groupe |
Path Parameters
Identifiant de l'utilisateur Id de l'utilisateur qui a vu/partagé le bien
Example:
125
Query Parameters
Mot de passe pour l'accès sécurisé
Example:
"api_key_here"
Si la valeur est 'optin', active l'optin pour l'utilisateur. Sinon, désactive l'optin.
Example:
"optin"
Response
Optin mis à jour avec succès
Retour positif du serveur
Statut de la requête
Example:
"ok"

