Télécharger le PDF d'un document
curl --request GET \
--url https://flatbay.fr/fr/api/document/{id}/pdfimport requests
url = "https://flatbay.fr/fr/api/document/{id}/pdf"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://flatbay.fr/fr/api/document/{id}/pdf', 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/document/{id}/pdf",
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/document/{id}/pdf"
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/document/{id}/pdf")
.asString();require 'uri'
require 'net/http'
url = URI("https://flatbay.fr/fr/api/document/{id}/pdf")
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"<string>"{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Endpoint Examples
Télécharger le PDF d'un document
Télécharge le PDF final du bail (document principal + annexes fusionnées), servi en pièce jointe. Renvoie une erreur 404 si le PDF n’a pas encore été généré (brouillon).
GET
/
document
/
{id}
/
pdf
Télécharger le PDF d'un document
curl --request GET \
--url https://flatbay.fr/fr/api/document/{id}/pdfimport requests
url = "https://flatbay.fr/fr/api/document/{id}/pdf"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://flatbay.fr/fr/api/document/{id}/pdf', 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/document/{id}/pdf",
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/document/{id}/pdf"
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/document/{id}/pdf")
.asString();require 'uri'
require 'net/http'
url = URI("https://flatbay.fr/fr/api/document/{id}/pdf")
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"<string>"{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}/api/document/:id/pdf?apiKey=xxxxx
Bail ou acte de cautionnement
Le PDF final (document principal + annexes fusionnées). L’URL prête à l’emploi (clé d’API incluse) est fournie dans le champpdf.url de la réponse de Détail d’un bail. Tant que le document n’a pas été généré (brouillon), pdf.available vaut false et cette route renvoie une erreur 404.
Pièce justificative d’un utilisateur
LedocumentId provient de Pièces justificatives d’un utilisateur. Les pages du fichier sont réassemblées en un seul PDF.
Au-delà de 30 Mo, l’assemblage est refusé (413 DOCUMENTTOOLARGE) : récupérer alors les pages une à une via /document/picture/{pageId}.
