Immobilienscout gem

This is an interface for Immobilienscout API

Example

Set up your keys in immobilienscout.rb inside initializers.

Immobilienscout.configure do |config|
  config.consumer_key = 'consumer_key'
  config.consumer_secret = 'consumer_secret'
  config.access_token = 'access_token'
  config.access_token_secret = 'access_token_secret'
  config.use_sandbox = true
end

Methods

Property

• Create property

Immobilienscout::API::Property.create({params})

• Publish property

Immobilienscout::API::Property.publish({params})

• Update property

Immobilienscout::API::Property.update(is24_id, {params})

Notes:

You have to send all attributes, also if only one attribute has changed. Otherwise Immobilienscout cannot interpret if a missing attribute should be filled in with NULL or not.

is24_id is the id returned by Immobilienscout when you first created the property.

If you have provided a custom id, you can use "ext-#{custom_id}" instead of the is24_id.

• Delete property

Immobilienscout::API::Property.destroy(is24_id)

• Show property

Immobilienscout::API::Property.show(is24_id)

Attachment

• Add attachments to property

Immobilienscout::API::Attachment.add(is24_id, binary_file, {metadata})

• Order attachments for a specific property

Immobilienscout::API::Attachment.put_order(is24_id, {params})

• Retrieve all attachments for a specific property

Immobilienscout::API::Attachment.retrieve_all(is24_id)

• Delete an attachment for a specific property

Immobilienscout::API::Attachment.destroy(is24_id, attachment_id)

On-Top Placements

• List all on-top placements

Immobilienscout::API::OnTopPlacement.index(placement_type)

• Add on-top placement

Immobilienscout::API::OnTopPlacement.add(is24_id, placement_type)

• Show on-top placement

Immobilienscout::API::OnTopPlacement.show(is24_id, placement_type)

• Delete on-top placement

Immobilienscout::API::OnTopPlacement.destroy(is24_id, placement_type)

Report

• Get scout report

Immobilienscout::API::Report.retrieve(is24_id, date_from, date_to)

IMPORTANT: Check Immobilienscout API Documentation about the needed params.

Immobilienscout API

https://api.immobilienscout24.de/our-apis/import-export.html