Соединения api. Использование и подключение API платформы beseller

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

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

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

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

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

Так же было принято решение, что запросы можно будет отсылать как через GET так и через POST запросы (здесь помог $_REQUEST в PHP). Такое решение позволило проводить тестирование API через GET запросы в любом доступном браузере.

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

Путь к папке 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 для тестирования новых методов перед их включением в продакшн версию

Весь механизм выглядит следующим образом:
Мы делаем запрос на сервер - к примеру www.example.com/api/?apitest.helloWorld= {}
На серверной стороне файл index.php - производит парсинг переданных параметров. Index.php берет всегда только первый элемент из списка переданных параметров $_REQUEST - это значит что конструкция вида www.example.com/api/?apitest.helloWorld= {}&apitest.helloWorld2 - произведет вызов только метода helloWorld в apitest. Вызова же метода helloWorld2 непроизойдет

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

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

Index.php

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

0){ require_once "apiEngine.php"; foreach ($_REQUEST as $apiFunctionName => $apiFunctionParams) { $APIEngine=new APIEngine($apiFunctionName,$apiFunctionParams); echo $APIEngine->callApiFunction(); break; } }else{ $jsonError->error="No function called"; echo json_encode($jsonError); } ?>

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

apiEngine.php

Вторым по важности является класс apiEngine - он представляет собой движок для вызова api и их методов.
apiFunctionParams = stripcslashes($apiFunctionParams); //Парсим на массив из двух элементов - название API, - название метода в API $this->apiFunctionName = explode("_", $apiFunctionName); } //Создаем JSON ответа function createDefaultJson() { $retObject = json_decode("{}"); $response = APIConstants::$RESPONSE; $retObject->$response = json_decode("{}"); return $retObject; } //Вызов функции по переданным параметрам в конструкторе function callApiFunction() { $resultFunctionCall = $this->createDefaultJson();//Создаем JSON ответа $apiName = strtolower($this->apiFunctionName);//название API проиводим к нижнему регистру if (file_exists($apiName . ".php")) { $apiClass = APIEngine::getApiEngineByName($apiName);//Получаем объект API $apiReflection = new ReflectionClass($apiName);//Через рефлексию получем информацию о классе объекта try { $functionName = $this->apiFunctionName;//Название метода для вызова $apiReflection->getMethod($functionName);//Провераем наличие метода $response = APIConstants::$RESPONSE; $jsonParams = json_decode($this->apiFunctionParams);//Декодируем параметры запроса в JSON объект if ($jsonParams) { if (isset($jsonParams->responseBinary)){//Для возможности возврата не JSON, а бинарных данных таких как zip, png и др. контетнта return $apiClass->$functionName($jsonParams);//Вызываем метод в API }else{ $resultFunctionCall->$response = $apiClass->$functionName($jsonParams);//Вызыаем метод в API который вернет JSON обект } } else { //Если ошибка декодирования JSON параметров запроса $resultFunctionCall->errno = APIConstants::$ERROR_ENGINE_PARAMS; $resultFunctionCall->error = "Error given params"; } } catch (Exception $ex) { //Непредвиденное исключение $resultFunctionCall->error = $ex->getMessage(); } } else { //Если запрашиваемый API не найден $resultFunctionCall->errno = APIConstants::$ERROR_ENGINE_PARAMS; $resultFunctionCall->error = "File not found"; $resultFunctionCall->REQUEST = $_REQUEST; } return json_encode($resultFunctionCall); } } ?>

apiConstants.php

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

MySQLiWorker.php

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

dbName = $dbName; self::$instance->dbHost = $dbHost; self::$instance->dbUser = $dbUser; self::$instance->dbPassword = $dbPassword; self::$instance->openConnection(); } return self::$instance; } //Определяем типы параметров запроса к базе и возвращаем строку для привязки через ->bind function prepareParams($params) { $retSTMTString = ""; foreach ($params as $value) { if (is_int($value) || is_double($value)) { $retSTMTString.="d"; } if (is_string($value)) { $retSTMTString.="s"; } } return $retSTMTString; } //Соединяемся с базой public function openConnection() { if (is_null($this->connectLink)) { $this->connectLink = new mysqli($this->dbHost, $this->dbUser, $this->dbPassword, $this->dbName); $this->connectLink->query("SET NAMES utf8"); if (mysqli_connect_errno()) { printf("Подключение невозможно: %s\n", mysqli_connect_error()); $this->connectLink = null; } else { mysqli_report(MYSQLI_REPORT_ERROR); } } return $this->connectLink; } //Закрываем соединение с базой public function closeConnection() { if (!is_null($this->connectLink)) { $this->connectLink->close(); } } //Преобразуем ответ в ассоциативный массив public function stmt_bind_assoc(&$stmt, &$out) { $data = mysqli_stmt_result_metadata($stmt); $fields = array(); $out = array(); $fields = $stmt; $count = 1; $currentTable = ""; while ($field = mysqli_fetch_field($data)) { if (strlen($currentTable) == 0) { $currentTable = $field->table; } $fields[$count] = &$out[$field->name]; $count++; } call_user_func_array("mysqli_stmt_bind_result", $fields); } } ?>

apiBaseClass.php

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

mySQLWorker = MySQLiWorker::getInstance($dbName,$dbHost,$dbUser,$dbPassword); } } function __destruct() { if (isset($this->mySQLWorker)){ //Если было установленно соединение с базой, $this->mySQLWorker->closeConnection(); //то закрываем его когда наш класс больше не нужен } } //Создаем дефолтный JSON для ответов function createDefaultJson() { $retObject = json_decode("{}"); return $retObject; } //Заполняем JSON объект по ответу из MySQLiWorker function fillJSON(&$jsonObject, &$stmt, &$mySQLWorker) { $row = array(); $mySQLWorker->stmt_bind_assoc($stmt, $row); while ($stmt->fetch()) { foreach ($row as $key => $value) { $key = strtolower($key); $jsonObject->$key = $value; } break; } return $jsonObject; } } ?>

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

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

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

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

createDefaultJson(); $retJSON->withoutParams = "It\"s method called without parameters"; return $retJSON; } //http://www.example.com/api/?apitest.helloAPIWithParams={"TestParamOne":"Text of first parameter"} function helloAPIWithParams($apiMethodParams) { $retJSON = $this->createDefaultJson(); if (isset($apiMethodParams->TestParamOne)){ //Все ок параметры верные, их и вернем $retJSON->retParameter=$apiMethodParams->TestParamOne; }else{ $retJSON->errorno= APIConstants::$ERROR_PARAMS; } return $retJSON; } //http://www.example.com/api/?apitest.helloAPIResponseBinary={"responseBinary":1} function helloAPIResponseBinary($apiMethodParams){ header("Content-type: image/png"); echo file_get_contents("http://habrahabr.ru/i/error-404-monster.jpg"); } } ?>

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

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

Function helloAPI() { $retJSON = $this->createDefaultJson(); $retJSON->withoutParams = "It\"s method called without parameters"; return $retJSON; }

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

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

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

Function helloAPIWithParams($apiMethodParams) { $retJSON = $this->createDefaultJson(); if (isset($apiMethodParams->TestParamOne)){ //Все ок параметры верные, их и вернем $retJSON->retParameter=$apiMethodParams->TestParamOne; }else{ $retJSON->errorno= APIConstants::$ERROR_PARAMS; } return $retJSON; }
Результат выполнения

helloAPIResponseBinary

И последний метод helloAPIResponseBinary - вернет бинарные данные - картинку хабра о несуществующей странице (в качестве примера)
function helloAPIResponseBinary($apiMethodParams){ header("Content-type: image/jpeg"); echo file_get_contents("http://habrahabr.ru/i/error-404-monster.jpg"); }
Как видно - здесь есть подмена заголовка для вывода графического контента.
Результат будет такой

Steam_api.dll – один из файлов, входящих в пакет инсталляции игрового клиента Steam. Вероятнее всего, вы оказались на этой странице из-за ошибки, вызванной отсутствием данного файла. Данная ошибка часто возникает как раз в тот момент, когда геймер запускает игру, надеясь хорошо провести несколько часов своего времени в виртуальном мире. Рассмотрим способы устранения этой ошибки . В интернете есть много различных советов по устранению этой досадной неполадки, но почти все они работают только в отдельных случаях. Универсальных и 100% решений нет, но два из них может попробовать применить каждый. Итак..

Восстановление файла в автоматическом режиме.

Логично предположить, что если переустановить Steam, то Steam_api.dll восстановится. Но терять сохраненные данные нам тоже не хочется, поэтому для начала нужно их сохранить. Перейдите в C:\Program Files\Steam и сделайте резервные копии файла steam.exe и папки Steamapps . Теперь нужно удалить Steam и установить его снова. Если вы используете ломанные версии программы, проблема может быть в антивирусе, который блокирует crack-и и измененные DLL-файлы. Отключите его на время установки, а также изучите отчеты сканера, в которых может оказаться и Steam_api.dll файл.

Ручное восстановление файла.

Теоритически можно вернуть файл в ручную. Скопировать его нужно в системную папку и папку с программой. Нажмите кнопку «Скачать», которую вы видите чуть выше и загрузите архив с файлом. В архиве будет подробная инструкция по копированию и регистрации данного файла в системе.

Не так давно один из моих посетителей мне задал вопрос по e-mail : "". Я решил, что это будет весьма полезно другим пользователям, тем более, что на кажущуюся сложность процесса, всё очень и очень просто. Необходимо лишь обладать самыми элементарными знаниями PHP .

Если Вы вдруг не понимаете, о чём идёт речь, то прочитайте сначала статью: . Идём дальше. Давайте разберём, а для каких сайтов нужен вообще API :

Первое, что необходимо усвоить - это то, что API нужен далеко не каждому сайту (даже если он принадлежит одной из вышеуказанных групп).

Если же Вы считаете, что API на Вашем сайте необходим, то давайте разберём пример того, как он создаётся. Пусть у нас будет такая задача: есть ЭПС (как, например, WebMoney ). И мы хотим, чтобы пользователь мог из своего кода, пользуясь нашим API , узнать свой баланс на счёте.

Создадим файл (например, api.php ), который у нас будет принимать GET-запросы от пользователей на получение различной информации. Напишем в этом обработчике такой код:

if ($_GET["action"] == "getbalance") {
$balance;
//Узнаём из базы данных баланс аккаунта и записываем в переменную balance
echo $balance;
}
?>

Теперь разработчики API должны дать информацию пользователям о том, как надо отправлять запрос, чтобы пользователь мог узнать свой баланс на аккаунте:

Http://mysite.ru/api.php?action=getbalance&key=fa9sgwlgjs9gdsjlgjdsjglsdlgs

Этот запрос пользователи формируют в своих скриптах (например, через cURL ). Параметр key - это уникальный ключ каждого пользователя. И ответом этого запроса будет число, отвечающее за баланс пользователя. Аналогично создаются и все другие возможности API . Можно добавлять другие различные параметры: например, получить список операций пополнения счёта с одной даты по другую. Желательно, сами списки возвращать в формате JSON .

У геймеров часто возникает неполадка, говорящая о не нахождении системой файла Steam_api.dll, потому хочется узнать Steam_api.dll, что это за ошибка? Сервис Steam – известная платформа с широким выбором игровых приложений и программ. В состав данного сервиса входит динамическая библиотека, необходимая для запуска, функционирования и взаимодействия сервера с приложениями – это Steam_api.dll для Windows 7,8,10, которая и позволяет выстраивать взаимосвязи. Однако иногда у пользователя запуск игры сопровождается уведомлением, что на компьютере отсутствует Steam_api.dll. Причиной неполадки может быть дублирование файлов библиотеки, потому система считывает неверное имя, или из-за блокировки антивирусом.

Когда отсутствует Steam api dll, что делать? Пользователю необходимо скачать файл Steam_api.dll на ПК. Для устранения возникшей ошибки существуют несколько путей решения: если Steam_api.dll был заблокирован антивирусом, его восстанавливают из карантина. Необходимо добавить файл в список исключений. Также можно заново закачать игру, перед тем отключив антивирус, а Steam_api.dll установится автоматически в комплексе с игрой. Следующим способом сделать приложения рабочими – установить сам Steam , который распакует все необходимые файлы на компьютер . Но перед скачиванием, нужно удалить предыдущую версию программы из всех источников.

Третий вариант устранения проблемы с потерей динамической библиотеки – отдельный файл Steam_api.dll скачать бесплатно. Он доступен для бесплатного скачивания с сайтов, предоставляющих необходимые играм утилиты и программы. Библиотека загружается на компьютер, а местоположение, куда следует поместить файл, зависит от разрядности виндовс, ее можно узнать, если посмотреть в сведениях о системе.

Как исправить ошибку?

Способ 1.

Файл Steam_api.dlll, принадлежит библиотеки Steam , поэтому достаточно её установить если у Вас её нет, или переустановить если у Вас она повреждена.

Способ 2.

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

Последовательность регистрация файлов:

  1. Определяем какой разрядности Ваша Windows;
  2. Для 32 бит скачиваем только файл 32бит;
  3. Для 64 бит скачиваем как 32 так и 64 бит;
  4. Файл 32 бит помещаем в папку: C:\Windows\System32;
  5. Файл 64 бит помещаем в папку: C:\Windows\ SysWOW64;
  6. Для регистрации нажимаем комбинацию Win+R;
  7. Прописываем команду для 32: regsvr32 имя.dll (имя заменяем названием файла 32);
  8. Прописываем команду для 64: regsvr32 имя.dll (имя заменяем названием файла 64);
  9. Жмём "OK и перезагружаем ПК;
Поделиться: