Add a Request Header to a REST Request

See more REST Examples

Demonstrates Rest.AddHeader, which adds an HTTP request header field. The 1st argument is the field name and the 2nd is the value. Adding a header whose name already exists replaces the previous value.

var
success: Boolean;
rest: HCkRest;
bTls: Boolean;
bAutoReconnect: Boolean;
responseText: PWideChar;

begin
success := False;

rest := CkRest_Create();

//  Connect to the REST server.  The 3rd argument enables TLS (use 1 for HTTPS on port 443),
//  and the 4th enables automatic reconnection if the connection is dropped between requests.
bTls := True;
bAutoReconnect := True;
success := CkRest_Connect(rest,'example.com',443,bTls,bAutoReconnect);
if (success = False) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

//  Add request header fields.  The 1st argument is the field name and the 2nd is the value.
//  Adding a header with a name that already exists replaces the previous value.
CkRest_AddHeader(rest,'Accept','application/json');
CkRest_AddHeader(rest,'X-Custom-Header','example-value');

responseText := CkRest__fullRequestNoBody(rest,'GET','/api/data');
if (CkRest_getLastMethodSuccess(rest) = False) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;
Memo1.Lines.Add(responseText);

CkRest_Dispose(rest);