Integra_Tour :: Интегриран подход за развитие на културни и природни обекти в Чепеларе, България и Просочани, Гърция

Управление на информацията и метаданните чрез API

Приложно-програмният интерфейс позволява на регистрираните потребители на базата данни и различни разработчици да извършват комуникация с нея, като извличат, редактират, изтриват и т.н. нейната информация. Нерегистрирани потребители и разработчици нямат свободен достъп до базата данни чрез RESTful API-а (JSON REST API). Достъпът чрез набора от функционалности и правила, позволяват на различни части от софтуерна програма да комуникира с друга такава, като тази комуникация се осъщестява чрез принципите на REST и HTTP и осигурява базови операции чрез GET, POST и DELETE.

Оторизация:
За да се инициира всяка една от операциите, е необходимо да се зададе конкретен адрес за нея.

https://www.database.integratour.org/API/list/ - За извличане на списък със спесимени https://www.database.integratour.org/API/details/ - За извличане на детайна информация за конкретен спесимен. https://www.database.integratour.org/API/delete/ - За изтриване на спесимен.

За да се осъществи връзка посредством API-а, се осъществява идентификация с потребителското име (e-mail адреса от регистрацията) и текущата парола за достъп.
Подаването им става посредством $_GET метод, като за целта се дефинират следните две променливи: ?user=EMAIL&pass=PASSWORD И двете променливи са задължителни за всяко действие и е необходимо предаването им при осъществяване на връзка с API-a.

Променливата "user=" подава EMAIL (необходимо е да се замени с Вашия e-mail адрес от регистрацията Ви към базата данни или портала).
Променливата "pass=" подава PASSWORD(необходимо е да се замени с Вашaтa актуална парола към регистрацията Ви в базата данни или портала).

Да се отбележи, че е необходимо профила да е активен и одобрен от администратор, в противен случай няма да бъде изпълнена заявката.

Избор на език:
API-а връща ресурси на повече от един език. Тази функционалност работи при условие, че за съответните ресурси са били въведени на съответните езици. За целта в заявката към API-а се добавя променлива "lang=" със стойност името на желания език във формат ISO 639-1 (пример: bg, en или gr). Пример за употреба на тази променлива е:
?lang=bg Поддържани езици: български (bg), английски (en) и гръцки (gr). Променливата е задължителна и без нейното посочване заявките няма да бъдат изпълнени.

Споменатият набор от пронеливи е задължителен за всички заявки към API-а, като за различните заявки има различен допълнителен набор от променливи спомагащи за определяне и иницииране на операциите.

Извличане на списък със спесимени

https://www.database.integratour.org/API/list/ - адрес на заявката

Къде	Име	Тип	Задължително	Описание
GET	user	string	да	E-mail адресът за идентификация от регистрацията.
GET	pass	string	да	Паролата за идентификация от регистрацията.
GET	lang	string	да	Името на езика за отговор във формат ISO 639-1 (bg, en или gr).
GET	sort	int	не	Възможни са три стойности, спрямо които връща резултатите сортирани: 0 - по подразбиране спрямо датата на добавяне/редактиране. 1 - по възходящ азбучен ред (от А до Я) 2 - по низходящ азбучен ред (от Я до А)
GET	limit	string	не	В случай, че е указано връща конкретен брой записи. Посочвайки се единичен лимит - връща зададената бройка от 0 резултат. Могат да се покажат и резултатите посредством посочване на начало и край: Пример: "10,20" - в този случай ще върне между 10 и 20 резултат

Отговoри за грешка:

401 - Липсващи данни за идентификация (Missing authentication data). 401 - Невалиди данни за идентификация (Invalid authentication). 405 - Невалиди данни за език (Invalid language data).

Успех

200 - Всичко е успешно и предава данните в "data" (OK) 204 - Всичко е успешно, но няма резултати (No content.).

За извличане на детайна информация за конкретен спесимен

https://www.database.integratour.org/API/details/ - адрес на заявката

Къде	Име	Тип	Задължително	Описание
GET	user	string	да	E-mail адресът за идентификация от регистрацията.
GET	pass	string	да	Паролата за идентификация от регистрацията.
GET	lang	string	да	Името на езика за отговор във формат ISO 639-1 (bg, en или gr).
GET	id	int	да	ID на спесимена

Отговoри за грешка:

401 - Липсващи данни за идентификация (Missing authentication data). 401 - Невалиди данни за идентификация (Invalid authentication). 405 - Невалиди данни за език (Invalid language data). 405 - Липсаващ или невалиден ID номер на спесимена (Empty or invalid ID).

Отговoри за успех 200 - Всичко е успешно и предава данните в "data" (OK).

За изтриване на спесимен

https://www.database.integratour.org/API/delete/ - адрес на заявката

Къде	Име	Тип	Задължително	Описание
GET	user	string	да	E-mail адресът за идентификация от регистрацията.
GET	pass	string	да	Паролата за идентификация от регистрацията.
GET	lang	string	да	Името на езика за отговор във формат ISO 639-1 (bg, en или gr).
GET	id	int	да	ID на спесимена

Отговoри за грешка:

401 - Липсващи данни за идентификация (Missing authentication data). 401 - Невалиди данни за идентификация (Invalid authentication). 403 - Неуспешно изтриване (Forbidden). 405 - Невалиди данни за език (Invalid language data). 405 - Липсаващ или невалиден ID номер на спесимена (Empty or invalid ID).

Успех 200 - Всичко е успешно и предава данните в "data" (OK).

Европейски съюзПроектът е реализиран с финансовата подкрепа на ЕС

This Web Platform has been created within the framework of the Project “Integrated Tourism Approach For the Development of Cultural and Natural Sites in Chepelare, Bg and Prosotsani, Gr” (INTEGRA_TOUR), financed under the INTERREG V-A Cooperation Program "Greece-Bulgaria 2014-2020", Subsidy Contract No B2.6c.01/31.08.2017.The Project is co funded by the European Regional Development Fund and by national funds of the countries participating in the Interreg V-A “Greece - Bulgaria 2014-2020” Cooperation Programme.

The contents of this document are sole responsibility of the Municipality of Chepelare and can in no way be taken to reflect the views of the European Union, the participating countries the Managing Authority and the Joint Secretariat.