API (Application Programming Interface) Документация

Препоръчително е, тази документация да се разглежда от технически грамотни специалисти. Ако Вие не сте такъв, моля обърнете се към вашия софтуерен доставчик.

Web Адреси

  • ProductionAPI - API интерфейс към портала www.Bulgarian-Offers.com. Важно: Преди да започнете да използвате production API се уверете в работоспособността на API клиента Ви, като за целта използвайте SandboxAPI
  • SandboxAPI - място за тестване и development. Всички данни в тази система са тестови и не подлежат на публикуване в главния портал.
  • CreateAPIAccessKey - Инструкции за генериране на API ключ за достъп до ProductionAPI или SandboxAPI.
  • RegisterNewUser - Инструкции за регистриране на нов API потребител.
  • WSDLFileDefinition - XML описание на предлаганите Web Услуги.
  • api(at)bulgarian-offers.com - изпращайте виски Ваши въпроси и коментари на този email адрес.

Налични Web Услуги/Функции

  • PublishProperty - публикуване/добавяне на имот/обява. При успешна публикация се връща стойност с PropertyID на имота/обявата.
  • GetPropertyByID - получаване на детайлна информация за имот/обява по зададено PropertyID.
  • GetPropertyByMyID - получаване на детайлна информация за имот/обява по зададено MyPropertyID.
  • UnPublishPropertyByID - премахване/изтриване на имот/обява от базата по зададено PropertyID.
  • UnPublishPropertyByMyID - премахване/изтриване на имот/обява от базата по зададено MyPropertyID.
  • UnPublishAllProperties - премахване/изтриване на всички публикувани имоти/обяви.
  • UpdateProperty - актуализиране на информацията за публикуван имот/обява.

Предефинирани сложни типове от данни

  • TypeProperty - Параметри от този тип съдържат детайлна информация за имот.
  • TypeContactPerson - Параметри от този тип съдържат информация относно лицето за контакт към съответната обява.
  • TypeLocation - Параметри от този тип съдържат информация относно местоположение (адрес) на имот.
  • TypePropertyContactPersonLocation - Сложен тип от данни обединяващ детайлна информация за имот, адрес и лице за контакт, като сложни подтипове.

Обща Информация

  • APIShortDescription - Кратко описания на възможностите, които предлага API системата.

Помощни средства

Topic revision: r19 - 2008/10/15 - 19:02:50 - GeorgiKuzmanov
 
www.Bulgarian-Offers.com Documentation
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback