Feedback Pays-Bas

Bêta

Gérer les codes postaux manquants aux Pays-Bas.

GEThttps://api.pro6pp.nl/v2/feedback/nl/postcode

Vue d'ensemble

Lists the postal codes added by the authenticated subscription.

ParamètresChaîne de requête

authKeystringObligatoire

Every request needs an API key, which you can get in the portal.

When you call the API from a browser, visitors can see your API key. Limit it to your own domains in the portal, or send the requests through your own server so the key stays hidden.

Réponses

200Postcodes added by your subscription, or an empty array when there are noneListe de résultats
ChampTypeValeur d'exempleDescription
municipalitystring"Amsterdam"

The municipality as submitted with the postal code.

postalCodestring"1012BZ"

The six-position postal code in uppercase without a space, such as "1012BZ".

provincestring"Noord-Holland"

The province as submitted with the postal code.

settlementstring"Amsterdam"

The settlement as submitted with the postal code.

latnumberPeut être nullnull

The submitted latitude, rounded to 5 decimals, or null when none was given.

lngnumberPeut être nullnull

The submitted longitude, rounded to 5 decimals, or null when none was given.

Exemple de réponse
[
  {
    "municipality": "Amsterdam",
    "postalCode": "1012BZ",
    "province": "Noord-Holland",
    "settlement": "Amsterdam",
    "lat": null,
    "lng": null
  }
]

Erreurs

Champs d'une réponse d'erreur
ChampTypeDescription
error_idstring

The reason the request failed, such as INVALID_VALUE. The response lists the reasons this operation returns.

errorsarray of object

One entry per problem found in the request.

errors[].messagestring

A readable explanation of the problem, in English.

errors[].helpstring

A link to the documentation section that covers the problem.

errors[].parameterany

The parameter the problem is about. Usually its name; a list when several parameters are involved, or a name with the values to choose from when the request must select one.

errors[].valueany

The value the request sent for parameter, when it has one.

401Non autorisé
UNAUTHORIZED

The API key is missing, unknown, revoked or expired, its subscription is not active, the request does not match the key's allowlist, or the subscription does not include this call.

UNAUTHORIZED
{
  "error_id": "UNAUTHORIZED",
  "errors": [
    {
      "message": "No authorization token provided",
      "help": "https://pro6pp.nl/docs/v2/redoc#section/Authentication"
    }
  ]
}

Exemples de code

curl "https://api.pro6pp.nl/v2/feedback/nl/postcode?authKey=YOUR_API_KEY"

Nous vous encourageons à demander un exemple de code dans votre langue préférée.