File tree 2 files changed +43
-2
lines changed
2 files changed +43
-2
lines changed Original file line number Diff line number Diff line change 1
- # textru-api
2
- Text.ru API's php connector
1
+ # Описание
2
+ PHP коннектор для API сайта text.ru.
3
+ Легко интегрируется в основные php фреймворки (протестирован на Laravel).
4
+
5
+ ##Установка
6
+ composer install textru-api
7
+
8
+ ##Описание API
9
+ Используется POST версия API от text.ru, более подробную информацию об API можно найти по ссылке:
10
+ https://text.ru/api-check/manual
11
+
12
+ ##Примеры
13
+ Все методы можно использовать как статические (без создания класса).
14
+
15
+ ####Добавление текста на проверку
16
+ ``` php
17
+ //Добавление текста на проверку
18
+ $userkey = 'Ваш text.ru userkey';
19
+ $text = 'Проверяемый текст, не менее 100 символов';
20
+ $options = ["exceptdomain"=>"mydomain.ru"]; //Необязательный параметр. Массив дополнительных параметров (см. описание API)
21
+
22
+ $result = TextRuApi::add($userkey, $text);
23
+ $uid = $result["text_uid"]; //идентификатор текста, сохраните его для следующего шага
24
+ ```
25
+
26
+ ####Получение результатов проверки
27
+ ``` php
28
+ $jsonvisible = 'detail'; //Необязательный параметр. Укажите "detail" чтобы получить расширенные данные по тексту
29
+ $result = TextRuApi::get($userkey, $uid, $jsonvisible);
30
+ ```
31
+
32
+ ##PHPUnit тесты
33
+ Запуск из корня компонента
34
+ ``` bash
35
+ phpunit ./tests/AddMethodTest.php --no-coverage
36
+ ```
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " krylov123/textru-api" ,
3
3
"description" : " Text.ru API's php connector" ,
4
+ "license" : " MIT" ,
5
+ "authors" : [
6
+ {
7
+ "name" : " Alexandr Krylov" ,
8
+
9
+ }
10
+ ],
4
11
"autoload" : {
5
12
"psr-4" : {
6
13
"TextRuApi\\ " : " src/"
You can’t perform that action at this time.
0 commit comments