Пример сървъра API за разработване на клиентски приложения - миротворец - и софтуер
терминология
Сървър, от страна на сървъра - набор от скриптове и бази данни, работещи на услугата на сървъра. На задния.
Клиентската част, клиентско приложение - всяко приложение от трета страна (в този случай се отнася до мобилно приложение), което взаимодейства с услугата за данни чрез REST API чрез изпращане на заявки за сървъра част и получаване на резултатите от него.
REST версия API 1.0 Ограничения
За да се ускори процеса на развитие на сървъра, ще бъдат използвани:
● HTTP протокол. Следващата версия е планирано да се използва HTTPS (необходимо купят сертификат)
● Името на предаване метод като параметър, а не част от пътя. използването на двата варианта са планирани в следващата версия.
● Тип на заявката - GET. Следващата версия - GET и POST.
● Показва резултати в JSON формат.
● използване на потребителско име и парола на потребител удостоверяване. Следващата версия - за OAuth 2.0.
Как да се използва REST API
REST API определя набор от методи, за които външни приложения могат да отправят искания и да получават отговори.
С цел да се извика методът на API, трябва да изпълни искането за да стигнем до протокола HTTP.
● API версия - v1.
● Името на метода - от следния списък от методи.
● Метод параметри - параметри на съответния метод API.
● Задължително параметри на заявката - ще бъдат обсъдени по-долу.
В отговор на искането за прилагане получава резултата в JSON формат. Encoding резултат - UTF-8.
Ако искането е успешен, съдържанието на резултата се показва в ключов резултат. Ако заявката не се осъществи, текстът на код и грешки се показват в ключов грешка.