Feedback Nederland

Bèta

Beheer ontbrekende adressen in Nederland.

OpenAPI-referentie Download de database

VeldAdres Postcode

GETList addresses POSTAdd an address DELETERemove an address

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

Overzicht

Lists the addresses added by the authenticated subscription.

ParametersQuerystring

authKeystringVereist

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.

Antwoorden

200Addresses added by your subscription, or an empty array when there are noneLijst met resultaten

Veld	Type	Voorbeeldwaarde	Beschrijving
countryCode	string	"NL"	The ISO 3166-1 alpha-2 country code of the address ("NL").
postalCode	string	"1012BZ"	The six-position postal code in uppercase without a space, such as "1012BZ".
settlement	string	"Amsterdam"	The settlement of the postal code, or an empty string for a PO box.
street	string	"Bethaniënstraat"	The street of the postal code, the submitted street when the postal code itself was added as feedback, or "Postbus" for a PO box.
streetNumber	number	1000	The house number.
lat	number	niet in voorbeeld	The submitted latitude, rounded to 5 decimals; left out when none was given.
lng	number	niet in voorbeeld	The submitted longitude, rounded to 5 decimals; left out when none was given.
premise	string	niet in voorbeeld	The house number addition as submitted; left out when there is none.
claim	string	niet in voorbeeld	The reason the subscriber gave for adding the address; left out when none was given.

Voorbeeld antwoord

[
  {
    "countryCode": "NL",
    "postalCode": "1012BZ",
    "settlement": "Amsterdam",
    "street": "Bethaniënstraat",
    "streetNumber": 1000
  }
]

Fouten

Velden van een foutantwoord

Veld	Type	Beschrijving
error_id	string	The reason the request failed, such as `INVALID_VALUE`. The response lists the reasons this operation returns.
errors	array of object	One entry per problem found in the request.
errors[].message	string	A readable explanation of the problem, in English.
errors[].help	string	A link to the documentation section that covers the problem.
errors[].parameter	any	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[].value	any	The value the request sent for `parameter`, when it has one.

401Niet geautoriseerd

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"
    }
  ]
}

Codevoorbeelden

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

Wij moedigen u aan om voorbeeldcode aan te vragen in de taal van uw voorkeur.