REST API

Entry Point

https://dashboard.appartement-construction.com/api

à ajouter POST /annonce/count/country

à ajouter POST /annonce/count/regions

Annonce Service

Common accepted JSON Reponse

• code : 200
• status : ok
• data
• id
• external_reference
• programme_id
• client_id
• commune
• commune_longitude
• commune_latitute
• libelle
• description
• surface
• prix
• adresse
• documents
• name
• path
• links
• first
• last
• prev
• next
• meta
• current_page
• from
• last_page
• path
• per_page
• to
• total

Common JSON Error Response

• code : http request code
• status : error
• message : verbose error message

Method : List

POST

Returns all published annonce (perfect method for testing)

[ENTRY POINT]/annonce/index

• API : annonce
• Verb : index
• Param : Content-Type : application/json
• website : string - website code - required

Exemple

curl -X POST -k -H 'Content-Type: application/json' -i 'https://dashboard.appartement-construction.com/api/annonce/index' --data '{"paginate":15, "website":"ACdev"}'

Method : Show

POST

Returns one result tobe shown

[ENTRY POINT]/annonce/show

• API : annonce
• Verb : show
• Param : Content-Type : application/json
• website : string - website code - required
• id : int - required

Method : Search By Zip Code and Range

POST

Returns all published annonce by zip code and range from the average point to the most wildly

[ENTRY POINT]/annonce/search/zip

• API : annonce
• Verb : search/zip
• Param : Content-Type : application/json
• website : string - website code - required
• zip : string - required
• country : string - iso code - if empty fallback to 'fr'
• range : int - unit km - if empty fallback to 0 = no range search
• paginate : int - if empty fallback to 10
• order_on : string - column for order request
• order_dir : string - direction, can be ASC or DESC, if empty DESC is default
• max_price : int - if empty not used in search
• room : int - if empty not used in search

Exemple

curl -X POST -k -H 'Content-Type: application/json' -i 'https://dashboard.appartement-construction.com/api/annonce/search/zip/68420/country/fr/range/10/paginate/15' --data '{"zip":"68280", "country":"fr", "range":0, "paginate":15, "website":"ACdev","order_on":"updated_at","oder_dir":"DESC","max_price":500000, "room":2}'

Method : Search By State

POST

Returns all published by state code and range

[ENTRY POINT]/annonce/search/state

• API : annonce
• Verb : search/state
• Param : Content-Type : application/json
• website : string - website code - required
• state : string - required
• country : string - iso code - if empty fallback to 'fr'
• paginate : int - if empty fallback to 10
• order_on : string - column for order request
• order_dir : string - direction, can be ASC or DESC, if empty DESC is default
• max_price : int - if empty not used in search
• room : int - if empty not used in search

Exemple

curl -X POST -k -H 'Content-Type: application/json' -i 'https://dashboard.appartement-construction.com/api/annonce/search/state' --data '{"state":"68", "country":"fr", "paginate":15, "website":"ACdev","order_on":"updated_at","order_dir":"DESC","max_price":500000, "room":2}'

Method : Search By Region

POST

Returns all published by region code and range

[ENTRY POINT]/annonce/search/region

• API : annonce
• Verb : search/state
• Param : Content-Type : application/json
• website : string - website code - required
• region : string - region name - required
• country : string - iso code - if empty fallback to 'fr'
• paginate : int - if empty fallback to 10
• order_on : string - column for order request
• order_dir : string - direction, can be ASC or DESC, if empty DESC is default
• max_price : int - if empty not used in search
• room : int - if empty not used in search

Exemple

curl -X POST -k -H 'Content-Type: application/json' -i 'https://dashboard.appartement-construction.com/api/annonce/search/region' --data '{"region":"alsace", "country":"fr", "paginate":15, "website":"ACdev","order_on":"updated_at","order_dir":"DESC","max_price":500000, "room":2}'

Contact Service

Method : Create

POST

Returns all published annonce (perfect method for testing)

[ENTRY POINT]/contact/create

• API : annonce
• Verb : create
• Param : Content-Type : application/json
• website : string - website code - required
• annonce_id ou programme_id - id of the add to make contact on
• civilite : M, MME, MLLE ou vide
• prenom
• nom
• email
• phone
• code_postal_recherche
• ville_recherche
• type_commercialisation : acheter | investir | louer | louer_etudiant | vente | gerer_bien
• optin_annonceur
• optin_partenaire
• optin_siteweb
• exported
• message
• from
• utm_source
• utm_medium
• utm_campaign
• utm_term
• utm_content

Exemple

curl -X POST -k -H 'Content-Type: application/json' -i 'https://dashboard.appartement-construction.com/api/contact/create' --data '{"prenom":"Prenom", "nom":"Nom", "email":"mail@free.fr","programme_id":"178","website":"ACdev"}'