API, REST-запросы, ClientToken

@Fox78 · Регистрация: 16.03.2017

Author24 — интернет-сервис помощи студентам

Здравствуйте, пытаюсь освоить API – REST-запросы и JSON-ответы.
Стоит задача работы с девайсом по API.

Есть параметры REST-запроса:
URL: http://<server-name>[:server-port]/api/codes? orderId = { orderId } & param1={ param1 } & param2 = { param2 }
Метод: GET
Тип orderId – UUID
Тип param1 – строка
Тип param2 – целочисленный

JSON-ответ – массив данных JSON Array of Strings

Для отладки пользуюсь утилиткой Curl.

Пример запроса:
curl -X GET -H "clientToken: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" "http://localhost:28999/api/codes?orderId=6f6088f9-f739-41b8-8dfa-5fa795a56cfe& param1 =99999999999999& param2 =2"
Терминалом перехватываю данные, которые поступают в порт:

Код

GET /api/codes?orderId=6f6088f9-f739-41b8-8dfa-5fa795a56cfe& param1=99999999999999& param2=2 HTTP/1.1
Host: localhost:28999
User-Agent: curl/7.55.1
Accept: */*
clientToken: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Реальный сервер отвечает адекватным ответом:

Код

{"globalErrors":["Order not found"],"success":false}

Пытаюсь повторить тот же запрос средствами делфи, проблема возникает с clientToken.

Данные из терминала при отправке запрос средствами делфи:

Код

GET /api/codes?orderId=6f6088f9-f739-41b8-8dfa-5fa795a56cfe&param1=99999999999999&param2=2&clientToken=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Connection: Keep-Alive
Accept: */*
Accept-Charset: UTF-8, *;q=0.8
User-Agent: Embarcadero RESTClient/1.0
Host: localhost:28999

Значение clientToken пристраивается за параметрами паровозом. И реальный сервер ругается ошибкой «HTTP/1.1 400 Bad Request» .

В делфи использую:
RESTClient, RESTRequest, RESTResponse, OAuth2Authenticator.
Скриншоты ниже.

Помогите, пожалуйста, с clientToken.
Это мое первое знакомство с API, много я еще не знаю, может быть что-то упускаю из виду.

@Zergius · 27.09.2018, 09:12

Может добавить заголовок вручную:

Delphi

1	RESTClient1.SetHTTPHeader('clientToken','XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX');

И UserAgent бы поменять тоже.

@Fox78 · 28.09.2018, 02:03 **[ТС]**

Zergius, не помогло, но подтолкнуло в нужном направлении, спасибо! =)
Ниже рабочий код:

Delphi

unit API;
interface
uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, IPPeerClient, Vcl.StdCtrls, REST.Client,
  Data.Bind.Components, Data.Bind.ObjectScope, REST.Authenticator.OAuth,
  FireDAC.Stan.StorageJSON, REST.Types, System.JSON, System.Net.URLClient;
 
type
  TForm1 = class(TForm)
    Button1: TButton;
    Memo1: TMemo;
    RESTClient1: TRESTClient;
    RESTRequest1: TRESTRequest;
    RESTResponse1: TRESTResponse;
    procedure Button1Click(Sender: TObject);
    procedure RESTRequest1HTTPProtocolError(Sender: TCustomRESTRequest);
  private
    { Private declarations }
  public
    { Public declarations }
  end;
 
var
  Form1: TForm1;
 
implementation
 
{$R *.dfm}
 
procedure TForm1.Button1Click(Sender: TObject);
begin
RESTClient1.Accept:='*/*';
RESTClient1.AcceptCharset:='UTF-8, *;q=0.8';
RESTClient1.BaseURL:='http://localhost:28999';
RESTClient1.UserAgent:='agent';
 
RESTRequest1.Accept:='*/*';
RESTRequest1.AcceptCharset:='UTF-8, *;q=0.8';
RESTRequest1.Method:=rmGET;
RESTRequest1.Resource:='api/codes';
RESTRequest1.Timeout:=30000;
 
RESTRequest1.Params.Clear;
RESTRequest1.Params.Add;
RESTRequest1.Params[0].Kind:=TRESTRequestParameterKind.pkHTTPHEADER;
RESTRequest1.Params[0].name:='clientToken';
RESTRequest1.Params[0].Options:=[poDoNotEncode];
RESTRequest1.Params[0].Value:='XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX';
 
RESTRequest1.Params.Add;
RESTRequest1.Params[1].name:='orderId';
RESTRequest1.Params[1].Value:='6f6088f9-f739-41b8-8dfa-5fa795a56cfe';
 
RESTRequest1.Params.Add;
RESTRequest1.Params[2].name:='param1';
RESTRequest1.Params[2].Value:='99999999999999';
 
RESTRequest1.Params.Add;
RESTRequest1.Params[3].name:='param2';
RESTRequest1.Params[3].Value:='2';
 
RESTRequest1.Execute;
ShowMessage(RESTResponse1.Content);
end;
 
end.

Запрос перехваченный терминалом (ClientToken там, где нужно):

Код

GET /api/codes?orderId=6f6088f9-f739-41b8-8dfa-5fa795a56cfe&param1=99999999999999&param2=2 HTTP/1.1
Connection: Keep-Alive
Accept: */*
Accept-Charset: UTF-8, *;q=0.8
User-Agent: agent
clientToken: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Host: localhost:28999

@Fox78 0 / 0 / 0 Регистрация: 16.03.2017 Сообщений: 32
		1
	API, REST-запросы, ClientToken 27.09.2018, 07:52. Показов 16126. Ответов 2 Метки api, rest (Все метки) Здравствуйте, пытаюсь освоить API – REST-запросы и JSON-ответы. Стоит задача работы с девайсом по API. Есть параметры REST-запроса: URL: http://<server-name>[:server-port]/api/codes? orderId = { orderId } & param1={ param1 } & param2 = { param2 } Метод: GET Тип orderId – UUID Тип param1 – строка Тип param2 – целочисленный JSON-ответ – массив данных JSON Array of Strings Для отладки пользуюсь утилиткой Curl. Пример запроса: curl -X GET -H "clientToken: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" "http://localhost:28999/api/codes?orderId=6f6088f9-f739-41b8-8dfa-5fa795a56cfe& param1 =99999999999999& param2 =2" Терминалом перехватываю данные, которые поступают в порт: Код GET /api/codes?orderId=6f6088f9-f739-41b8-8dfa-5fa795a56cfe& param1=99999999999999& param2=2 HTTP/1.1 Host: localhost:28999 User-Agent: curl/7.55.1 Accept: / clientToken: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX Реальный сервер отвечает адекватным ответом: Код {"globalErrors":["Order not found"],"success":false} Пытаюсь повторить тот же запрос средствами делфи, проблема возникает с clientToken. Данные из терминала при отправке запрос средствами делфи: Код GET /api/codes?orderId=6f6088f9-f739-41b8-8dfa-5fa795a56cfe&param1=99999999999999&param2=2&clientToken=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1 Connection: Keep-Alive Accept: / Accept-Charset: UTF-8, *;q=0.8 User-Agent: Embarcadero RESTClient/1.0 Host: localhost:28999 Значение clientToken пристраивается за параметрами паровозом. И реальный сервер ругается ошибкой «HTTP/1.1 400 Bad Request» . В делфи использую: RESTClient, RESTRequest, RESTResponse, OAuth2Authenticator. Скриншоты ниже. Помогите, пожалуйста, с clientToken. Это мое первое знакомство с API, много я еще не знаю, может быть что-то упускаю из виду. Миниатюры 0

	28.09.2018, 02:03

API, REST-запросы, ClientToken

Решение