Appeler une API REST en PHP

Question

Notre client m'a fourni une API REST à laquelle je dois faire un appel en PHP. Mais en fait, la documentation fournie avec l'API est très limitée, donc je ne sais pas vraiment comment appeler le service.

J'ai essayé de le chercher sur Google, mais la seule chose qui est apparue était un tutoriel Yahoo ! déjà expiré sur la façon d'appeler le service. Il ne mentionne pas les en-têtes ou toute autre information approfondie.

Existe-t-il des informations décentes sur la manière d'appeler une API REST, ou de la documentation à ce sujet ? Parce que même sur W3schools, ils ne décrivent que la méthode SOAP. Quelles sont les différentes options pour créer une API REST en PHP ?

Answer 1

Vous pouvez accéder à n'importe quelle API REST avec PHPs cURL Extension. Cependant, la documentation de l'API (méthodes, paramètres, etc.) doit être fournie par votre client !

Exemple :

// Method: POST, PUT, GET etc
// Data: array("param" => "value") ==> index.php?param=value

function CallAPI($method, $url, $data = false)
{
    $curl = curl_init();

    switch ($method)
    {
        case "POST":
            curl_setopt($curl, CURLOPT_POST, 1);

            if ($data)
                curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
            break;
        case "PUT":
            curl_setopt($curl, CURLOPT_PUT, 1);
            break;
        default:
            if ($data)
                $url = sprintf("%s?%s", $url, http_build_query($data));
    }

    // Optional Authentication:
    curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
    curl_setopt($curl, CURLOPT_USERPWD, "username:password");

    curl_setopt($curl, CURLOPT_URL, $url);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

    $result = curl_exec($curl);

    curl_close($curl);

    return $result;
}

Answer 2

Si vous avez une url et que votre php le supporte, vous pouvez simplement appeler file_get_contents :

$response = file_get_contents('http://example.com/path/to/api/call?param1=5');

si $response est JSON, utilisez json_decode pour le transformer en tableau php :

$response = json_decode($response);

si $response est XML, utiliser la classe simple_xml :

$response = new SimpleXMLElement($response);

http://sg2.php.net/manual/en/simplexml.examples-basic.php

Answer 3

Utilisez Guzzle . Il s'agit d'un "client PHP HTTP qui facilite l'utilisation de HTTP/1.1 et rend la consommation de services Web moins pénible". Travailler avec Guzzle est beaucoup plus facile que de travailler avec cURL.

Voici un exemple tiré du site Web :

$client = new GuzzleHttp\Client();
$res = $client->get('https://api.github.com/user', [
    'auth' =>  ['user', 'pass']
]);
echo $res->getStatusCode();           // 200
echo $res->getHeader('content-type'); // 'application/json; charset=utf8'
echo $res->getBody();                 // {"type":"User"...'
var_export($res->json());             // Outputs the JSON decoded data

Answer 4

La méthode CURL est la plus simple à mettre en œuvre. Voici un appel simple

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "THE URL TO THE SERVICE");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, POST DATA);
$result = curl_exec($ch);

print_r($result);
curl_close($ch);

Answer 5

Il y a beaucoup de clients en fait. L'un d'eux est Nuisibles - regardez ça. Et gardez à l'esprit que ces appels REST sont de simples requêtes http avec différentes méthodes : GET, POST, PUT et DELETE.