CityDate API - CPFRA
Der Endpunkt CPFRA validiert, ob eine Stadt oder ein Ort für ein bestimmtes Geburtsdatum existierte und gültig war.
Verwandte CityDate-Dokumentation - Der Endpunkt
API – Beschreibung – CityDate – BirthLocality →
CityDate – Einführung →
CPFRA prüft die Gültigkeit für ein einzelnes Orts-/Geburtsdatums-Paar. Suchen Sie stattdessen die Ortssuche nach Name, Postleitzahl oder INSEE-Code?API – Beschreibung – CityDate – BirthLocality →
CityDate – Einführung →
CPFRA
Anfrage
Sowohl GET als auch POST werden unterstützt.
{SERVER_ADDRESS} und {LICENCE_CODE} werden von DQE bei der Kontoerstellung bereitgestellt. Wenden Sie sich an Ihren DQE-Kundenbetreuer, um diese Zugangsdaten zu erhalten.
GEThttps://{SERVER_ADDRESS}/CPFRA/?DDN={BIRTHDATE}&INSEE={INSEE_CODE}&CP={POSTAL_CODE}&Localite={CITY_NAME}&Licence={LICENCE_CODE}
Codebeispiele
Suche nach Stadtname
curl "https://{SERVER_ADDRESS}/CPFRA/?DDN=1980-05-15&Localite=EVRY&Licence={LICENCE_CODE}"
fetch("https://{SERVER_ADDRESS}/CPFRA/?" + new URLSearchParams({
DDN: "1980-05-15",
Localite: "EVRY",
Licence: "{LICENCE_CODE}"
}))
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.get(
"https://{SERVER_ADDRESS}/CPFRA/",
params={
"DDN": "1980-05-15",
"Localite": "EVRY",
"Licence": "{LICENCE_CODE}",
},
)
print(response.json())
<?php
$params = http_build_query([
'DDN' => '1980-05-15',
'Localite' => 'EVRY',
'Licence' => '{LICENCE_CODE}',
]);
$ch = curl_init("https://{SERVER_ADDRESS}/CPFRA/?{$params}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
axios.get('https://{SERVER_ADDRESS}/CPFRA/', {
params: {
DDN: '1980-05-15',
Localite: 'EVRY',
Licence: '{LICENCE_CODE}'
}
})
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String url = "https://{SERVER_ADDRESS}/CPFRA/"
+ "?DDN=1980-05-15&Localite=EVRY&Licence={LICENCE_CODE}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var url = "https://{SERVER_ADDRESS}/CPFRA/" +
"?DDN=1980-05-15&Localite=EVRY&Licence={LICENCE_CODE}";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://{SERVER_ADDRESS}/CPFRA/" +
"?DDN=1980-05-15&Localite=EVRY&Licence={LICENCE_CODE}"
resp, err := http.Get(url)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
POSThttps://{SERVER_ADDRESS}/CPFRA/
Senden Sie die folgenden Parameter im Request-Body im Format x-www-form-urlencoded. Die Serveradresse bleibt in der URL.
Codebeispiele
Suche nach Stadtname
curl -X POST "https://{SERVER_ADDRESS}/CPFRA/" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "DDN=1980-05-15" \
-d "Localite=EVRY" \
-d "Licence={LICENCE_CODE}"
fetch("https://{SERVER_ADDRESS}/CPFRA/", {
method: "POST",
headers: { "Content-Type": "application/x-www-form-urlencoded" },
body: new URLSearchParams({
DDN: "1980-05-15",
Localite: "EVRY",
Licence: "{LICENCE_CODE}"
})
})
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.post(
"https://{SERVER_ADDRESS}/CPFRA/",
data={
"DDN": "1980-05-15",
"Localite": "EVRY",
"Licence": "{LICENCE_CODE}",
},
)
print(response.json())
<?php
$ch = curl_init("https://{SERVER_ADDRESS}/CPFRA/");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
'DDN' => '1980-05-15',
'Localite' => 'EVRY',
'Licence' => '{LICENCE_CODE}',
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
const qs = require('querystring');
axios.post('https://{SERVER_ADDRESS}/CPFRA/', qs.stringify({
DDN: '1980-05-15',
Localite: 'EVRY',
Licence: '{LICENCE_CODE}'
}))
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String form = "DDN=1980-05-15&Localite=EVRY&Licence={LICENCE_CODE}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://{SERVER_ADDRESS}/CPFRA/"))
.header("Content-Type", "application/x-www-form-urlencoded")
.POST(HttpRequest.BodyPublishers.ofString(form))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var form = new Dictionary<string, string> {
["DDN"] = "1980-05-15",
["Localite"] = "EVRY",
["Licence"] = "{LICENCE_CODE}"
};
var response = await client.PostAsync(
"https://{SERVER_ADDRESS}/CPFRA/",
new FormUrlEncodedContent(form));
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
form := url.Values{}
form.Set("DDN", "1980-05-15")
form.Set("Localite", "EVRY")
form.Set("Licence", "{LICENCE_CODE}")
resp, err := http.PostForm("https://{SERVER_ADDRESS}/CPFRA/", form)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
Parameter
| Parameter | Beschreibung | Pflicht / Optional |
|---|---|---|
| Licence | Lizenzcode. | Pflicht |
| DDN | Geburtsdatum im Format YYYY-MM-DD. |
Pflicht |
| INSEE | INSEE-Code. | Optional |
| CP | Postleitzahl. | Optional |
| Localite | Stadtname. | Optional |
Hinweis – Die Parameter
INSEE, CP und Localite sind jeweils optional, aber mindestens einer von ihnen muss angegeben werden — andernfalls schlägt die Anfrage fehl.Antwort
Form der Antwort - Die Antwort ist ein JSON-Objekt mit einem beliebigen numerischen Index als Schlüssel (z. B.
"1", "2"…) — ein Eintrag pro möglicher Übereinstimmung — statt eines JSON-Arrays. Iterieren Sie über die Werte des Objekts, anstatt von einer festen Menge an Schlüsseln auszugehen.| Schlüssel | Mögliche Werte | Beschreibung | Typ |
|---|---|---|---|
| Insee | 75113 |
INSEE-Code der Stadt. | STRING(10) |
| Localite | Paris |
Stadtname. | STRING(50) |
| Pays | FR |
ISO-2-Ländercode. | STRING(2) |
| CodePostal | 75013 |
Postleitzahl der Stadt. | STRING(10) |
| Status |
OK / KO
|
Gibt an, ob die Stadt für das angegebene Geburtsdatum gültig ist. | STRING(2) |
Antwortbeispiel
Mehrdeutiger Treffer bei Stadtname
{
"1": {"Localite": "EVRY", "Pays": "FR", "Insee": "89162", "CodePostal": "89140", "Status": "OK"},
"3": {"Localite": "EVRY", "Pays": "FR", "Insee": "91228", "CodePostal": "91080", "Status": "KO"},
"2": {"Localite": "EVRY", "Pays": "FR", "Insee": "91228", "CodePostal": "91000", "Status": "KO"}
}
Fehler
| HTTP | Beschreibung |
|---|---|
| 400 | Ungültige Anfrage oder fehlender Pflichtparameter — zum Beispiel ein fehlendes DDN oder Licence, oder wenn weder INSEE, CP noch Localite angegeben wurde. |
API testen
Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.
Konsole öffnen
Siehe auch
Verknüpfung mit