Débuter avec l'API REST

**CharleLéo** · 24/03/2016, 18h40

Bonjour,

Je désire utiliser une API REST dans une application. J'ai fouillé un peu partout pour savoir ce qu'était une API REST.

Il n'y a que deux heures environs que j'ai découvert que l'on pouvait utiliser ces API afin de récolter un certain nombre d'information sur un serveur.
Je sais que pour pouvoir utiliser ces API, il faut :

Au préalable fournir une 'authentification token' et parfois un user et un mot de passe.
Attendre la réponse du serveur
Envoyer des GET pour recevoir des infos
Envoyer des PUT pour mettre à jour des infos
Utiliser JSON pour le format des données

L'API concernée fonctionne sous HTTP(s).

Donc avant de me lancer un peu plus dans ce projet, j'aimerai savoir si avec LAZARUS, il était possible d'interroger une API (composant, librairie,etc...)

Merci de d'avance

**CharleLéo** · 26/03/2016, 08h26

Bonjour,

A force de fouiller sur le net, j'ai découvert qu'il fallait utiliser un client HTTP, et j'ai donc ajouté dans le uses fphttpclient.

Le code (l'API REST : www.google.com)

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
procedure TForm1.Button1Click(Sender: TObject);
  var
     http: TFPHTTPClient;
     formdata: TStrings;
     json:String;
     j:TJSONData;
     Arequest:TStream;
begin
 
     memo1.Clear;
     http := TFPHTTPClient.Create(nil);
     try
        // Connection à l'API REST
        http.put('http://google.com');
        memo1.Lines.Add(http.ResponseHeaders.Text);
        memo1.lines.add(chr(13));
        memo1.lines.add(inttostr(http.ResponseStatusCode));
        memo1.lines.add(chr(13));
        memo1.lines.add(http.ResponseStatusText);
        memo1.lines.add(chr(13));
        memo1.lines.add('-----------------------');
     finally
       http.Free;
     end;
end;
end.

Le resultat obtenu :

Nom : Resultat.PNG
Affichages : 2121
Taille : 22,1 Ko

Pour le moment je ne comprends pas tout ce qu'il y a dans le résultat.

A+

**FChrisF** · 26/03/2016, 13h56

Le code retour HTTP 411 indique, comme précisé, que la taille des données envoyées est manquante.

En fait, dans votre exemple, toutes les données à envoyer sont manquantes. La méthode HTTP 'PUT' nécessite en effet l'envoi de données complémentaires (comme POST): cf https://fr.wikipedia.org/wiki/Hypert...nsfer_Protocol.

Voici un rapide exemple basé sur le votre, mais qui fait plutôt un 'GET' (pas besoin de données complémentaires dans ce cas):

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
uses
  fphttpclient, fpjson;
 
function IsRedirect(ResponseStatus: integer): boolean;
 
begin
  case ResponseStatus of
  301, 302, 303, 307, 308:
    result := true;
  else
    result := false;
  end;
end;
 
function GetRedirect(const ResponseHeaders: TStrings; out NewLocation: string): boolean;
const LOCAT = 'LOCATION';
var i1, i2: integer;
begin
  result := false;
  for i1 := 0 to pred(ResponseHeaders.Count) do
    if UpperCase(Copy(Trim(ResponseHeaders[i1]), 1, Length(LOCAT))) = LOCAT then
      begin
        i2 := Pos(':', ResponseHeaders[i1]);
        if i2>0 then
          begin
            NewLocation :=Trim(Copy(ResponseHeaders[i1], i2 + 1, Length(ResponseHeaders[i1]) - i2));
            result := (NewLocation<>'');
          end;
      end;
end;
 
procedure TForm1.Button1Click(Sender: TObject);
  var
     http: TFPHTTPClient;
     formdata: TStrings;
     json:String;
     j:TJSONData;
     Arequest:TStream;
     NbrRedirect: integer;
     s1: string;
begin
 
     memo1.Clear;
     http := TFPHTTPClient.Create(nil);
     NbrRedirect := 0;
     s1 := 'http://google.com';
     while true do
       begin
          try
            // Connection à l'API REST
            http.get(s1);
          except
          end;
          if IsRedirect(http.ResponseStatusCode) then
            begin
              inc(NbrRedirect);
              if NbrRedirect>10 then Break;
              if not GetRedirect(http.ResponseHeaders, s1) then Break;
             end
          else
            Break;
        end;
      memo1.Lines.Add(s1);
      memo1.lines.add(chr(13));
      memo1.Lines.Add(http.ResponseHeaders.Text);
      memo1.lines.add(chr(13));
      memo1.lines.add(inttostr(http.ResponseStatusCode));
      memo1.lines.add(chr(13));
      memo1.lines.add(http.ResponseStatusText);
      memo1.lines.add(chr(13));
      memo1.lines.add('-----------------------');
      http.Free;
end;

Ce qui donne comme résultat:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
http://www.google.fr/?gfe_rd=cr&ei=GYX2Vp2WCPPt8wfsh6W4BQ
 
 
Date: Sat, 26 Mar 2016 12:48:25 GMT
Expires: -1
Cache-Control: private, max-age=0
Content-Type: text/html; charset=ISO-8859-1
P3P: CP="This is not a P3P policy! See https://www.google.com/support/accounts/answer/151657?hl=en for more info."
Server: gws
X-XSS-Protection: 1; mode=block
X-Frame-Options: SAMEORIGIN
Set-Cookie: NID=77=TLXinY0DRiC5qstPFuMAkE5CYJDucrNuJ4hCcOP6cUDTqsWklB75NxVbuiiGRPhfacJPlX5i9YXalVgunMj_-i95KWbwK0WpWijPPa0uoF-9_bieF6-BnX-VqW2TxkQE; expires=Sun, 25-Sep-2016 12:48:25 GMT; path=/; domain=.google.fr; HttpOnly
Accept-Ranges: none
Vary: Accept-Encoding
Transfer-Encoding: chunked
 
 
 
200
 
 
OK
 
 
-----------------------

Ceci étant, dans votre cas, il serait probablement préférable d'utiliser une bibliothèque de "plus haut niveau": comme Synapse ou Indy. Sinon, tout est compliqué (même une simple redirection HTTP).

De plus, il semble qu'il existe déjà un framework JSON/REST pour Free Pascal (mais je ne l'ai pas testé):

https://github.com/silvioprog/brookframework

Je dirais que cette dernière solution est probablement ce que vous recherchez.

**jurassic pork** · 26/03/2016, 13h59

hello,
le 411 Length required n'est pas bon signe car cela signifie que tu as une erreur http.

En utilisant le serveur Rest de test http://jsonplaceholder.typicode.com/ et le code suivant j'ai plus de chance que toi :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
// uses fphttp,fpjson,jsonparser,fphttpclient;    
procedure TForm1.Button1Click(Sender: TObject);
var
     http: TFPHTTPClient;
     formdata: TStrings;
     responseData : String;
     json:String;
     j:TJSONData;
     Arequest:TStream;
begin
 
     memo1.Clear;
     http := TFPHTTPClient.Create(nil);
     try
        // Connection à l'API REST
        responseData := http.get('http://jsonplaceholder.typicode.com/posts/1');
        memo1.Lines.Add(http.ResponseHeaders.Text);
        memo1.lines.add(chr(13));
        memo1.lines.add(inttostr(http.ResponseStatusCode));
        memo1.lines.add(chr(13));
        memo1.lines.add(http.ResponseStatusText);
        memo1.lines.add(chr(13));
        memo1.lines.add('-----------------------');
        memo1.Lines.add(responseData);
     finally
       http.Free;
     end;
end;

car j'obtiens :

Server: Cowboy
Connection: keep-alive
X-Powered-By: Express
Vary: Origin, Accept-Encoding
Access-Control-Allow-Credentials: true
Cache-Control: no-cache
Pragma: no-cache
Expires: -1
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Content-Length: 292
Etag: W/"124-yv65LoT2uMHrpn06wNpAcQ"
Date: Sat, 26 Mar 2016 12:52:33 GMT
Via: 1.1 vegur

200

OK

-----------------------
{
"userId": 1,
"id": 1,
"title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
"body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
}

il y a des données json qui sont retournées !

PS : FchrisF , je n'ai pas fait exprès d'écrire en même temps que toi

Ami calmant, J.P

**CharleLéo** · 26/03/2016, 19h17

bonjour et merci de vos réponses

Le code (minimal) est un code de test afin d'obtenir un jeton d'authentication auprés de l'API REST
En fait pour pouvoir utiliser l'API REST, je dois :

Ensuite une fois ce jeton obtenu, je dois envoyer dans le "body request" : (parsé en JASON) : { "user": "USER", "mdp": "MDP", "id": ID" }

Donc j'avance petit à petit.

Je vais aller faire un tour vers https://github.com/silvioprog/brookframework

A+

**CharleLéo** · 27/03/2016, 10h27

Bonjour,

Je pense que le framework "brookFramework" n'est pas adapté à ce que je veux faire. Mais j'avance à petit pas....

En fouillant, j'ai trouvé la bibliothèque SYNAPSE, et notamment la méthode HTTPMethod('put',url);

Donc mon problème est de savoir maintenant comment il faut que je passe dans l'URL les données d'authentification :

URL="http://xxxxx.com { "user": "USER", "mdp": "MDP", "id": ID" }"

Une fois authentification faite j'aurai comme réponse (parse en JSON) :

Code json :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
{
"Retour_status": "ok",
"data": {
"token": "xxxxxxxxxxxx"
}

Quelqu'un a une idée ?

Merci d'avance.

**CharleLéo** · 31/03/2016, 14h02

Je reviens sur le forum pour poster mon code qui fonctionne;
J'utilise la librairie indy 10. Attention, il ne faut pas oublier de copier sslEay32.dll et libeay32.dll dans le dossier du projet.

voici le code

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
function Tform1.Connecter(user,mdp,id:string):string;
var
  HTTP: TIdHTTP;
  RequestBody: TStringStream;
  ResponseBody: string;
  jsonData:TJsonData;
begin
  try
    HTTP := TIdHTTP.Create;
    // init du request body avec les paramètres autorisation spécifiés dans l'API REST utilisée
    RequestBody := TStringStream.Create('{"user": "'+user+'","password": "'+mdp+'","id": "'+id+'"}');
    try
      HTTP.Request.Accept := 'application/json';
      HTTP.Request.ContentType := 'application/json';
      // URL de connection à l'API REST
      ResponseBody := HTTP.Post('https://www.xxx',RequestBody);
      // ResponseBody  est sous forme JSON ==> spécification de l'API REST utilisée
      jsonData:=GETJSON(ResponseBody); // ===> nécessaire ?
      // dans l'objet JSON, je récupère la reponse de la connexion, ici le nom JSON est 'retour' (spécification de l'API REST utilisée)
      showMessage(jsonData.FindPath('retour').asString);
      // la fonction retourne la valeur du jeton d’autorisation du nom de l'objet JSON (spécification de l'API REST utilisée)
      Connecter:=jsonData.FindPath('data.jeton').AsString;
    finally
      RequestBody.Free;
    end;
    HTTP.Free;
  except
    on E: EIdHTTPProtocolException do
      begin
        WriteLn(E.Message);
        WriteLn(E.ErrorMessage);
      end;
    on E: Exception do
      begin
           WriteLn(E.Message);
      end;
  end;
end;

voilà, j'aimerai avoir votre avis.
Petite question : quelle est la différence entre GETJSON et JSON.parse ?

A+

**jurassic pork** · 01/04/2016, 00h48

hello,
tu devrais pouvoir t'en sortir sans utiliser indy et qu'avec les librairies free pascal. Depuis 2014 les librairies free pascal gère le https (sauf si il y a besoin d'un certificat). Il faut simplement que les dll ou so openssl soient vues par le système.
Voici un embryon de code exemple ou il y a dump des données json retournées (géré par les librairies fpjson et jsonparser)

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
// uses fphttpclient, fpjson, jsonparser; 
Procedure TForm1.DumpJSONData(J : TJSonData; DOEOLN : Boolean = True);
 
Var
  I : Integer;
  DataString : String;
 
begin
  // JSONType property determines kind of value.
  Case J.jsontype of
    jtNull   : Memo1.Append('Null');
    jtBoolean : If J.AsBoolean then
                  Memo1.Append('True')
                else
                  Memo1.Append('False');
    jtNumber : {JSONNumber has extra NumberType property
                which determines kind of value (int/float).}
               Case TJSONNumber(J).NumberType of
                 ntInteger : Memo1.Append(inttostr(J.AsInteger));
                 ntFloat   : Memo1.Append(floattostr(J.AsFloat));
               end;
    jtString : Memo1.Append('"' + J.AsString +'"');
    jtArray  : begin
               Memo1.Append('======================');
               For I:=0 to J.Count-1 do
                 begin
                 DumpJSONData(J.Items[I],False);
                 If I<J.Count-1 then
                   Memo1.Append('+++++++++++++++++++++++');
                 end;
               Memo1.Append('=======================');
               end;
    jtObject : begin
               Memo1.Append('========================');
               For I:=0 to J.Count-1 do
                 begin
                 Memo1.Append('"' + TJSONObject(J).Names[i] + '" : ');
                 DumpJSONData(J.Items[I],False);
                 If I<J.Count-1 then
                   Memo1.Append('+++++++++++++++++++++++++')
                 end;
               Memo1.Append('=========================');
               end;
   end;
   If DOEOLN then
     Memo1.Append('');
end;
 
procedure TForm1.bt_GetDataClick(Sender: TObject);
Var
  S : String;
  J: TJSONData;
  httpClient : TFPHTTPClient;
  user,pwd,id : String;
begin
  Memo1.Clear;
  user := 'user';
  pwd  := 'mdp';
  id := '5';
  httpClient := TFPHTTPClient.Create(nil);
  httpClient.AddHeader('Accept','application/json');
  httpClient.AddHeader('Content-Type','application/json');
  httpClient.RequestBody := TStringStream.Create('{"id": "'+id+'"}');
      try
//      S:= httpClient.Get('https://httpbin.org/post');
      S := httpClient.Post('https://httpbin.org/post');
      memo1.Append('Request Response : ' + httpClient.ResponseStatusText);
      except
      on e: Exception do
          begin
          ShowMessage('Exception : ' + e.Message);
          httpClient.Free;
          Exit;
          end;
      end;
    httpClient.Free;
    J:= GetJSON(S);
    DumpJsonData(J);
end;

et voici ce qui s'affiche :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
Request Response : OK
========================
"args" : 
========================
=========================
+++++++++++++++++++++++++
"data" : 
"{"id": "5"}"
+++++++++++++++++++++++++
"files" : 
========================
=========================
+++++++++++++++++++++++++
"form" : 
========================
=========================
+++++++++++++++++++++++++
"headers" : 
========================
"Accept" : 
"application/json"
+++++++++++++++++++++++++
"Content-Length" : 
"11"
+++++++++++++++++++++++++
"Content-Type" : 
"application/json"
+++++++++++++++++++++++++
"Host" : 
"httpbin.org"
=========================
+++++++++++++++++++++++++
"json" : 
========================
"id" : 
"5"
=========================
+++++++++++++++++++++++++
"origin" : 
"99.98.97.96"
+++++++++++++++++++++++++
"url" : 
"https://httpbin.org/post"
=========================

Ami calmant, J.P