Usage

To create, update, or delete one or more ads, send a POST request to https://hexon.ofof.nl

Authorization: Bearer <token-issued-by-ofof>
Content-Type: application/json

with JSON as the body

Schema

Use the following JSON schema in the body of the request

        
            { 
                "timestamp":353453535,
                "advertisements":[ 
                   { 
                      "ad_id":324234,
                      "advertiser_id":"rdc",
                      "actie":"create",
                      "omschrijving":{ 
                         "object_remarks":"Van een oud vrouwtje geweest",
                         "additional_info":"Kras op linker velg",
                         "remarks":"",
                         "extra":""
                      },
                      "odometer":5121,
                      "prijs":15672,
                      "btw_verrekenbaar":true,
                      "merk":"Nissan",
                      "model":"Leaf",
                      "type": "Tekna 40kWh",
                      "titel": "Nissan Leaf Tekna 40kWh - incl. Navi en Cruise Control"
                      "bouwjaar":2016,
                      "garanties":[ 
                         "bovag"
                      ],
                      "aanbieder_type":"dealer",
                      "kenteken":"AA-123-BB",
                      "kleur":"grijs",
                      "deeplink":"https://nissandealer.nl/auto?id=4353455",
                      "media":[ 
                         "https://nissandealer.nl/fotos/4353455/voorkant.jpg",
                         "https://nissandealer.nl/fotos/4353455/achterkant.jpg"
                      ]
                   }
                ]
             }
        
    

Testing

Use https://hexon.ofof.nl/test endpoint for testing purpose (HTTP POST request, with same headers as for https://hexon.ofof.nl)

You can check the results at https://hexon.ofof.nl/test/list (allow up to a minute for background processing)

Data fields

Field Type Description Required Restrictions
timestamp integer timestamp when message was sent yes Unix timestamp
advertisements array list of advertisements yes -
ad_id integer advertisement id yes -
advertiser_id string advertiser id yes -
actie string action for advertisement yes should be one of ["create","update","delete"]
omschrijving object description yes description split out according to https://documentation.doorlinkenvoorraad.nl/receiving_advertisements_from_dv/data_fields/description/
odometer integer odometer (number of kilometers driven) yes should be 0 or higher
prijs integer cost (without VAT) yes -
btw_verrekenbaar boolean if VAT can be deducted from the car (ie is it a 'btw' car, as opposed to a 'marge' car) yes -
merk string car brand yes -
model string car model yes equivalent of RDW 'Handelsbenaming' (f.e. 'Leaf' for 'Nissan Leaf Tekna 40kWh')
type string model type yes as detailed as possible (f.ex. 'Tekna 40kWh' for 'Nissan Leaf Tekna 40kWh')
titel string commercial title yes full ad title (f.ex. 'Renault Zoe Intens excl Accu')
bouwjaar integer year in which car was first registered yes -
garanties array list of warranties no possible values t.b.d.
aanbieder_type string type of seller no f.ex. 'dealer' or 'person'
kenteken string license plate no -
kleur string color no -
deeplink string URL of the ad at the dealer no -
media array car media (pictures) yes each picture should be referenced using its full URL, a minimum of 1 picture is required