подключение api к сайту php

В данной статье вы узнаете, как создать простой REST API в PHP.

1. Обзор проекта

1.1 Что такое REST API?

REST API позволяет вашему приложению взаимодействовать с одним или несколькими различными приложениями, используя концепции REST.

1.2 Зачем нужен REST API?

Во многих приложениях REST API необходим, потому что это самый легкий способ создания, чтения, обновления или удаления информации между различными приложениями через Интернет или протокол HTTP. Эта информация представляется пользователю в одно мгновение, особенно если вы используете JavaScript для отображения данных на веб-странице.

1.3 Где используется REST API?

REST API может использоваться любым приложением, которое может подключаться к Интернету. Если данные из приложения могут быть созданы, прочитаны, обновлены или удалены с помощью другого приложения, это обычно означает, что используется REST API.

2. Файловая структура

3. Настройка базы данных

3.1 Создание таблицы категорий

3.2 Дамп данных для таблицы категорий

3.3 Создание таблицы товаров

3.4 Дамп данных для таблицы товаров

3.5 Подключение к базе данных

Приведенный ниже код показывает учетные данные базы данных и метод для получения подключения к базе данных с помощью PDO.

Создайте папку api и откройте её. Создайте папку config и в ней создайте файл database.php со следующим кодом.

4. Получение товаров

4.1 Создание объекта Product

Код ниже содержит класс с именем Product и несколько свойств. Также показан метод конструктора, который принимает соединение с базой данных.

4.2 Создание файла для чтения товаров

Код ниже содержит заголовки о том, кто может читать этот файл и какой тип содержимого он будет возвращать.

4.3 Подключение к базе данных и таблице товаров

Замените комментарий // подключение к базе данных будет здесь в файле read.php следующим кодом.

4.4 Чтение товаров из базы данных

Замените комментарий // чтение товаров будет здесь в файле read.php следующим кодом.

4.5 Создание метода read()

4.6 Уведомление пользователя о том, что товары не найдены

Замените комментарий // ‘товары не найдены’ будет здесь в файле read.php следующим кодом.

5. Создание товаров

5.1 Создание файла create.php

Откройте папку product и создайте в ней файл create.php со следующим содержимым.

5.2 Создание метода create()

6. Получение одного товара

6.1 Создание файла read_one.php

6.2 Создание метода readOne()

7. Обновление товара

7.1 Создание файла update.php

7.2 Создание метода update()

8. Удаление товара

8.1 Создание файла delete.php

Откройте папку product и создайте файл delete.php со следующим содержимым.

8.2 Создание метода delete()

9. Поиск товаров

9.1 Создание файла search.php

В папке product создайте файл search.php со следующим кодом.

9.2 Создание метода search()

10. Пагинация товаров

10.1 Создание файла read_paging.php

В папке product создайте файл read_paging.php со следующим кодом.

10.2 Создание файла core.php

Этот файл содержит нашу базовую конфигурацию, такую как базовый URL и переменные пагинации.

Откройте папку config и создайте в ней файл core.php со следующим содержимым.

10.3 Создание метода readPaging()

10.4 Создание метода count()

Так же в классе Product (файл product.php) добавьте метод count() для создания массива пагинации.

10.5 Получение массива пагинации

11. Получение категорий

11.1 Создание объекта Category

Откройте папку objects и создайте новый файл category.php со следующим кодом.

11.2 Создание файла read.php

Создайте новую папку category в корне, и в ней файл read.php со следующим кодом.

11.3 Создание метода read()

Если вам понравилась данная статья, рекомендую к прочтению создание регистрации и авторизации в php с использованием JWT.

Надеюсь, вам понравилась данная информация. Если вам интересна тема web-разработки, то можете следить за выходом новых статей в Telegram.

Источник

Пишем свой API для сайта с использованием Apache, PHP и MySQL

С чего все началось

Разрабатывая проект, я столкнулся с необходимостью организации клиент-серверного взаимодействия приложений на платформах iOS и Android с моим сайтом на котором хранилась вся информация — собственно БД на mysql, картинки, файлы и другой контент.
Задачи которые нужно было решать — достаточно простые:
регистрация/авторизация пользователя;
отправка/получение неких данных (например список товаров).

И тут-то мне захотелось написать свой API для взаимодействия с серверной стороной — большей своей частью для практического интереса.

Входные данные

В своем распоряжении я имел:
Сервер — Apache, PHP 5.0, MySQL 5.0
Клиент — Android, iOS устройства, любой браузер

Я решил, что для запросов к серверу и ответов от него буду использовать JSON формат данных — за его простоту и нативную поддержку в PHP и Android. Здесь меня огорчила iOS — у нее нет нативной поддержки JSON (тут пришлось использовать стороннюю разработку).

Внешний вид запросов решено было сделать таким:
http://[адрес сервера]/[путь к папке api]/?[название_api].[название_метода]=[JSON вида <«Hello»:«Hello world»>]

Путь к папке api — каталог на который нужно делать запросы, в корне которого лежит файл index.php — он и отвечает за вызов функций и обработку ошибок
Название api — для удобства я решил разделить API группы — пользователь, база данных, конент и тд. В таком случае каждый api получил свое название
Название метода — имя метода который нужно вызвать в указанном api
JSON — строковое представление JSON объекта для параметров метода

Скелет API

Скелет API на серверной стороне состоит из нескольких базовых классов:
index.php — индексный файл каталога в Apache на него приходятся все вызовы API, он осуществляет парсинг параметров и вызов API методов
MySQLiWorker — класс-одиночка для работы с базой MySQL через MySQLi
apiBaseCalss.php — родительский класс для всех API в системе — каждый API должен быть наследован от этого класса для корректной работы
apiEngine.php — основной класс системы — осуществляет разбор переданных параметров (после их предварительного парсинга в index.php) подключение нужного класса api (через require_once метод), вызов в нем нужного метода и возврат результата в JSON формате
apiConstants.php — класс с константами для api вызовов и передачи ошибок
apitest.php — тестовый api для тестирования новых методов перед их включением в продакшн версию

Теперь подробней о каждом

Я попробовал достаточно документировать файлы, чтобы не занимать много место под текст. Однако в тех файлах где нет комментариев, я все ж приведу описание.

Index.php

Как уже говорил раньше это входной индексный файл для Apache а значит все вызовы вида www.example.com/api будет принимать он.

Первым делом устанавливаем тип контента — text/html (потом можно сменить в самих методах) и кодировку — UTF-8.
Дальше проверяем, что у нас что-то запрашивают. Если нет то выводим JSON c ошибкой.
Если есть параметры запроса, то подключаем файл движка API — apiEngine.php и создаем класс движка с переданными параметрами и делаем вызов api метода.
Выходим из цикла так как мы решили что будем обрабатывать только один вызов.

apiEngine.php

Вторым по важности является класс apiEngine — он представляет собой движок для вызова api и их методов.

apiConstants.php

Данный класс используется только для хранения констант.

MySQLiWorker.php

Класс-одиночка для работы с базой. В прочем это обычный одиночка — таких примеров в сети очень много.

apiBaseClass.php

Ну вот мы подошли к одному из самых важных классов системы — базовый класс для всех API в системе.

Как видно данный класс содержит в себе несколько «утилитных» методов, таких как:
конструктор в котором осуществляется соединение с базой, если текущее API собирается работать с базой;
деструктор — следит за освобождением ресурсов — разрыв установленного соединения с базой
createDefaultJson — создает дефолтный JSON для ответа метода
fillJSON — если подразумевается что запрос вернет только одну запись, то данный метод заполнит JSON для ответа данными из первой строки ответа от БД

Создадим свой API

Вот собственно и весь костяк этого API. Теперь рассмотрим как же это все использовать на примере создания первого API под названием apitest. И напишем в нем пару простых функций:
одну без параметров
одну с параметрами и их же она нам и вернет, чтобы было видно, что она их прочитала
одну которая вернет нам бинарные данные

И так создаем класс apitest.php следующего содержания

Для удобства тестирования методов, я дописываю к ним адрес по которому я могу сделать быстрый запрос для тестирования.

И так у нас три метода

helloAPI

Это простой метод без параметров. Его адрес для GET вызова www.example.com/api/?apitest.helloAPI=<>

Результатом выполнения будет вот такая страница (в браузере)

helloAPIWithParams

Этот метод принимает в параметры. Обязательным является TestParamOne, для него и сделаем проверку. Его его не передать, то будет выдан JSON с ошибкой

helloAPIResponseBinary

И последний метод helloAPIResponseBinary — вернет бинарные данные — картинку хабра о несуществующей странице (в качестве примера)

Как видно — здесь есть подмена заголовка для вывода графического контента.
Результат будет такой

Есть над чем работать

Для дальнейшего развития необходимо сделать авторизация пользователей, чтобы ввести разграничение прав на вызов запросов — какие-то оставить свободными, а какие-то только при авторизации пользователя.

Ссылки

Для тестирования выложил все файлы на github — simpleAPI

Источник

веб-сервисы — Как подключиться к API, используя PHP с файлом PFX и паролем?

Мне нужно подключиться к API компании, используя файл PFX и пароль, используя oauth2.

Я не очень знаком с использованием файлов PFX и не знаю, как подключиться к API, используя файл PFX и пароль. Я посмотрел здесь на SO, но не нашел много, чтобы помочь мне начать. Я искал в Google, но нашел несколько документов и пример кода, ни один из которых не работал. Я нашел следующий код, но он не работает для меня. Может кто-нибудь, пожалуйста, помогите мне заставить это работать?

Код, который я нашел и сейчас пытаюсь использовать, выглядит следующим образом:

Приведенный выше код дает мне следующую ошибку:

Ключ находится в том же каталоге, поэтому я не уверен, почему он не находит его. Возможно я подхожу к использованию файла PFX неправильно.

Решение

Я подходил к этому все неправильно. Из того, что я прочитал, и информации, которую я собрал, лучше всего конвертировать файл PFX в файл PEM. Я сделал это, используя cygwin со всеми необходимыми пакетами и openssl. Когда файл PFX был преобразован в PEM, я использовал команду curl с необходимыми учетными данными для подключения к API, из которого мне нужно получать данные. Команда, которую я выполнил из оболочки bash, выглядит следующим образом:

Я получил следующий ответ:

Мне также удалось проверить это соединение с помощью почтальона, и я постоянно получаю один и тот же ответ.

Я продолжаю разрабатывать решение для своих нужд на основе проведенных исследований. Решение PHP с использованием cURL ниже. Ниже приведены две функции и условие if. Условие if запускает соответствующую функцию, основываясь на том, был ли токен доступа уже добавлен в сеанс или нет. Если он не добавлен в сеанс, он извлечет его на основе учетных данных, которые необходимо добавить. Если он уже добавлен в сеанс, приступайте к получению необходимых данных.

Источник

Создание «API-Centric» Web Application на PHP

Что такое “API-Centric” Web Application?
Это веб приложение которое большая часть функционала реализуется через API. Например: если вы авторизовываетесь, то вы отправляете свои данные через функции API, а API уже возвращает результат success или же ошибку. Другой характеристикой API является то что API не зависит от состояния пользователя.

Создавая приложения таким способом, мы можем воспользоваться им в различных средах и различными людьми. В этой статье мы создадим простое TODO приложение и клиентскую часть взаимодействующую с серверной. let’s begin!

Шаг 2. Создание API сервера

Создадим 2 проекта: API сервер (back end) и клиентскую часть (front end)
Создайте папку simpletodo_api и в ней создайте index.php файл. Он будет являться главным контроллером нашего API (front controller) так что все запросы к серверу API будет осуществляться через этот файл. Откройте его и вставьте следующий код:

Теперь добавим необходимый функционал действию action. Мы создаём метод createAсtion. Если вы в хорошем настроении то можете создать и для других действий функционал, я лишь предоставил интерфейс.

Создаём todoItem.php в моделях, чтобы мы могли создать код, реализующий «Создание пункта списка». Кстати говоря в данном примере – без БД (на файлах). Вы, конечно же можете не ограничиваться.

Congratulations! Мы успешно создали API server и сделали вызов API.

Шаг 3. Защищаем API server с app id и app secret.
Сейчас наш api server принимает все запросы. Мы должны ограничить доступ к серверу, чтобы гарантировать, что только наши собственные клиенты имеют возможность сделать API запросы. Так же вы можете создать систему в которой пользователи могут создавать свои собственные приложения, которые имеют доступ к API серверу, подобно тому, как работает Facebook и Twtter приложения.
Начнём с создание пары id-key для клиентов, которые буду использовать наш сервер. Так как это демо, мы можем использовать рандомную 32 символьную строку. Для APP ID, скажем ‘app001′.
Откройте index.php и измените его:

Здесь мы просто создаём новую сессию пользователя, основанную на введённом логине и пароле. Это действие является простой комбинацией ключа, по которому мы можем получить доступ к хранящимся TODO спискам. Далее перенаправление на todo.php для начала взаимодействия с api server’ом. Прежде чем создать todo.php давайте сначала определим класс ApiCaller, который инкапсулирует все методы вызова API, которые нам понадобится, включая шифрование запросов.
Создаём apicaller.php:

Это должно выглядеть так:

Приятно смотрится, неправда ли? Добавим теперь той самой функциональности, new_todo.php
Который содержит вызов todo/create, создавая новый TODO item элемент. Создание других страниц: (update_todo.php и delete_todo.php) должно быть простым.
Откроем new_todo.php:

Заключение:
Есть много преимуществ в разработке приложений, сделанных с API. Если вы хотите создать Android версию SimpleTODO, то вся функциональность, которая может вам потребоваться, уже есть в API server, так что все, что вам нужно сделать, это просто создать Android клиент! Хотите, реорганизовать или оптимизировать некоторые классы? Нет проблем — просто убедитесь, что выходные данные будут теми же. Нужно добавить больше функциональности? Вы можете сделать это без изменения кода клиента!

Вдохновением служила статья nettuts
Пишите если где ошибся, и комментарии по поводу где что лучше можно было бы сделать

Источник

БЛОГ ПРО WEB

Рассказываю о web-разработке
и помогаю создавать сайты

Простой API для Вашего сайта

Возникла ситуация, когда необходимо использовать 2 БД MySQL на разных серверах для снижения нагрузки.

1 БД для основных задач и 2 БД для хранения различной статистики по всем модулям. А Статистика, как всем известно, — это куча цифр, которыми не хочется засорять основную БД.

Так как решил использовать сторонний сервер, на ум приходит API. В принципе, для меня то, что нужно, так как возможно может пригодиться и для моих пользователей для вывода своей статистики на своих проектах.

Oauth использовать решил не стоит, да и было интересно как выйдет API своими руками.

API, ну или Парсер

Да, действительно, способ проще чем кажется. Можно данный способ организации назвать как Парсер, ведь будем использовать @file_get_contents()

Но мне важен результат!

Качаем исходники тут и разбираем что к чему

Собираем функционал API

У нас в итоге получится 2 части.

Файлы клиентской части

А теперь по порядку каждый файл

Клиентская часть

$url — это адрес к нашему серверу, а точнее к файлу api.php (о нем читать ниже).

Дальше мы отправляем запрос @file_get_contents($get); к серверу и получаем ответ с результатом в формате json_decode()

Начал с клиентской части потому что, мне кажется интереснее посмотреть что получится, а не то как это сделано. И поэтому, вот как использовать MySQL удаленно

Подключаем function.api.php на нужных страницах для связи с API сервера со статистикой к примеру.

А остальное все итак понятно. Там написал все 4 функции для примера, используя таблицу в бд следующего вида

И тут логично понятные параметры

query — запрос (SELECT, UPDATE, INSERT или DELETE)

table — таблица в бд (в моем случае ‘scripts’)

where — условия обычного формата (тут не стал что то изобретать. Типа, [id=5 OR >

values — и тут передаем параметры для добавления и редактирования в следующем формате

Мне кажется, просто и понятно…

Серверная часть API

Конечно же config.php

Проверка и отправка запроса в БД через класс API

Конечно как вы понимаете, проверка такого рода

лишь как пример. Тут надо делать проверку ключа и ID пользователя на соответствие. Тут проблем думаю не будет.

И файл class.a.php для разных запросов и возвращения результата

местами требуются некоторые проверки для защиты, но не критичны. Даю код, чтобы смысл был понятен. Дальше уже сами дорабатывайте)

Расписывать не буду, итак ясно что делает данный файл…

Источник