REST Client Library: использование API ВКонтакте #2

Небольшая заметка по мотивам обсуждения предыдущей статьи на тему использования API ВКонтакте в Delphi.  Чтобы дважды не повторяться и не писать один и тот же код снова и снова, скажу, что в этой статье будут использованы наработки из предыдущей статьи и здесь я просто продолжу писать небольшое Android-приложение для ВК.

В принципе, задача реализации того  или иного API онлайн-сервиса в Delphi с использованием REST Client Library очень сильно упрощается и сводится, по большому счёту, к двум простым операциям: 1. составить и отправить запрос; 2. получить ответ в формате JSON и разобрать его. Нам уже не надо писать свои классы и целые модули для авторизации, как я это делал ранее. Не требуется даже разбирать ответ сервера, чтобы получить JSON-объект, т.к. библиотека вернет нам его сама, в случае успешного запроса. Однако, в некоторых случаях, например, как в случае с Dropbox, все же требуется небольшое вмешательство в работу библиотеки, но это, я бы сказал, особенности конкретного API, а не проблемы REST Client Library. 

После того, как я опубликовал заметку «REST Client Library: использование API ВКонтакте» в комментариях произошла небольшая беседа относительно кодировок текста. Что тут сказать? «Кракозябры» вместо текста — это настоящий бич разработчика :) А, если серьезно, то работа с кодировкой текста — дело серьезное и об этом я писал, но, правда, уже давным давно.

Итак,  как же REST Client Library справится с отправкой текста на сервер ВК? Проверим это на примере отправки простого текстового сообщения на стену авторизованного пользователя. Для этого немного допишем код нашего приложения для ВК (весь код которого представлен тут).

Первое, что нам необходимо добавить в приложении — это запросить необходимые права доступа. В API ВКонтакте при авторизации, как и в любых других API можно указывать параметр scopes, которые устанавливает права доступа для нашего приложения. О всех возможных правах доступа в ВК можно почитать на этой странице документации. Нам, по большому счету, потребуется всего одно значение — wall, чтобы иметь возможность публиковать записи на стене пользователя, но Вы также можете добавить свои значения из предложенного в документации списка и, например, попросить выдавать бессрочный токен доступа, право менять статус и т.д.

Второе, как правильно заметил один из постоянных читателей блога в предыдущей статье про ВК — это то, что при любых запросах к API ВК необходимо в обязательном порядке указывать версию API. Для того, чтобы узнать, какая версия API актуальная, необходимо зайти вот на эту страницу документации. На момент написания этой заметки актуальной версией API была версия 5.24.

Третье. Для многих запросов к API нам необходимо указывать идентификатор пользователя. Идентификатор текущего пользователя возвращается нам вместе с токеном доступа при авторизации.

Теперь реализуем все вышесказанное в коде. Для реализации первых двух пунктов  создадим две константы:

const
  cAppID = 'ХХХХХ';
  [....]
  cScope = 'wall';
  cAPIVersion = '5.24';

Для хранение идентификатора пользователя создадим переменную:

type
  TForm1 = class(TForm)
    [..]
  private
    UserId: string;
    [...]
  public
    [...]
  end;

Теперь допишем методы Auth и AfterRedirect. Всего две строки — по одной в каждом методе:

procedure TForm1.AfterRedirect(const AURL: string; var DoCloseWebView: boolean);
var i:integer;
    Str: string;
    Params: TStringList;
begin
  i:=pos('#access_token=',AURL);
  if (i>0) and (OAuth2Authenticator1.AccessToken=EmptyStr) then
    begin
      Str:=AURL;
      Delete(Str,1,i);
      Params:=TStringList.Create;
      try
        [...]
        UserId:=Params.Values['user_id']; //сохраняем идентификатор пользователя
      finally
        Params.Free;
      end;
      WebForm.Close;
    end;
end;
 
procedure TForm1.Auth;
begin
 [...]  
  OAuth2Authenticator1.Scope:=cScope; //задаем права доступа для приложения
  WebForm.ShowWithURL(OAuth2Authenticator1.AuthorizationRequestURI);
end;

Всё. Теперь наше приложение будет запрашивать необходимые права и сохранять идентификатор пользователя. Можно приступать к реализации метода отправки сообщения на стену пользователя. Ознакомиться с документацией к методу можно здесь.

Бросим на форму кнопку TButton и определим её свойство Text как «Message». Должно получиться как-то так:

В обработчике OnClick кнопки напишем следующий код:

procedure TForm1.Button3Click(Sender: TObject);
var S: string;
begin
  S:=InputBox('Новое сообщение','Текст сообщения','Текст для проверки');
  RESTRequest1.Resource:='wall.post';
  RESTRequest1.Method:=TRESTRequestMethod.rmPOST;
  RESTRequest1.Params.Clear;
  with RESTRequest1.Params.AddItem do
    begin
      name:='v';
      Value:=cAPIVersion;
      Kind:=TRESTRequestParameterKind.pkGETorPOST;
      Options:=[poDoNotEncode];
    end;
  with RESTRequest1.Params.AddItem do
    begin
      name:='owner_id';
      Value:=UserId;
      Kind:=TRESTRequestParameterKind.pkGETorPOST;
      Options:=[poDoNotEncode];
    end;
  with RESTRequest1.Params.AddItem do
    begin
      name:='message';
      Value:=S;
      Kind:=TRESTRequestParameterKind.pkGETorPOST;
      Options:=[poDoNotEncode];
    end;
  RESTRequest1.Execute;
end;

Собственно, это и всё, что нам необходимо для того, чтобы отправить простой текст на сервер. На что здесь стоит обратить внимание?
1. Для отправки сообщения используем метод POST:

RESTRequest1.Method:=TRESTRequestMethod.rmPOST;

2. Все три параметра запроса мы вставляем в запрос как есть, т.е. без перекодирования:

Options:=[poDoNotEncode];

3. Строка S:string вставляется в запрос опять же как есть — ничего нигде не перекодируется и не преобразуется:

with RESTRequest1.Params.AddItem do
  begin
    [...]
    Value:=S;
    [...]
  end;

Проверим, как сработает наше приложение.

1. Авторизуемся в ВК:

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

2. Пробуем отправить на стену сообщение.

Для «чистоты эксперимента» текст специально задан на родном русском языке. Смотрим, что появилось на страничке в ВК:

Как видите, всё в полном порядке. Текст пришел без всяких кракозябр. Что ещё раз доказывает, что REST Client Library прекрасно справляется с возложенными на неё функциями.

Книжная полка

	Автор: Дмитрий Осипов Название: Delphi. Программирование для Windows, OS X, iOS и Android Описание Подробно рассматривается библиотека FM, позволяющая создавать полнофункциональное программное обеспечение для операционных систем Windows и OS X, а также для смартфонов и планшетных компьютеров, работающих под управлением Android и iOS
	Автор: Антон Григорьев Название: О чем не пишут в книгах по Delphi Описание: Рассмотрены малоосвещенные вопросы программирования в Delphi. Описаны методы интеграции VCL и API. Показаны внутренние механизмы VCL и приведены примеры вмешательства в эти механизмы. Рассмотрено использование сокетов в Delphi: различные режимы их работы, особенности для протоколов TCP и UDP и др.