Cregennan / vkminiapps-api

Простое API для несложных проектов

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Simple JSON API

Простое JSON-Pure API для простых задач, таких как VK MiniApps.

Использование

GET запросы должны посылаться на api.php. Данные будут возвращены в виде JSON строки. Структура ответа:

{
  "status":"success",
  "response":{
    "message":"Successful Default API Method Call"
   }
}

Поддерживается

  • Проверка подписи VK MiniApps
  • Проверка типов входных параметров
  • Защита от MySQL иньекций

Требования:

  • PHP 7.3
    • MySQLi

Типы входных данных:

  • integer
  • string
  • double
  • Json
  • DateTime
  • Email
  • HumanName

Стандартные типы ошибок

1XX - Ошибки API

Числовой код Буквенный код Описание ошибки
100 undefined_error Неизвестная ошибка
101 access_denied Доступ запрещен. Выдается при неправильной подписи входных данных или ее отсутствии.
102 access_denied Ошибка вызова метода. Вызывается при внутренней ошибке API.
103 wrong_method Неверный метод. Название метода не передано в качестве параметра, или данный метод не существует.
104 params_not_declared Параметры не определены. При включенной проверке типов параметров, класс метода не содержит $ParamsList, или он объявлен неверно.
105 wrong_method_parameter Неверный тип входного параметра. Тип параметра не соответствует заявленному в $ParamsList Дополнительно будет выведено подробное описание параметра.

About

Простое API для несложных проектов

License:MIT License


Languages

Language:PHP 100.0%