PUT to Restful API using PHP cURL

[Inspector Mills]

Hi there

I need to use cURL to change the status of an order on a Restful API using PHP.  The instructions I received from the developers of the API is as follows:

curl -X PUT \
-d
"order[status]=S"
[site url]

In addition to this, they informed me that it is necessary to be signed in, with the credentials supplied.

So, my problems are these:
1. what is the syntax for the PUT action in PHP cURL?
2. how do I sign in to the site with PHP?

Any guidance will be appreciated

Thanks.

[Jacques1]

1: RTFM! We're not gonna read it to you.

 

2: There is no magical “sign in” parameter. The API provider has to tell you how they expect you to send the credentials.

[jazzman1]

 

what is the syntax for the PUT action in PHP cURL?

 

PUT method? I've not heard of it more than 13 years ago when Java was on top of the world. Is it a Java application? 

[Jacques1]

Looks like you've indeed missed the last 13 years.

[jazzman1]

The programming is just my hobby Jacques

[Inspector Mills]

Hi

Thanks for the feedback. It turned out that the authentication was what was getting me stuck.

This is what eventually worked:

<?php

$order = “[API order no]";
$data = http_build_query(array("order[status]" => "S"));
$email = “";
$password = “[password]";
$url = "[API URL]/$order";

$ch=curl_init();

curl_setopt($ch,CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC ) ;
curl_setopt($ch, CURLOPT_USERPWD, "$email:$password");
curl_setopt($ch, CURLOPT_SSLVERSION,3);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

curl_exec($ch);
curl_close($ch);

?>

Regards

Mills

[gizmola]

Since it was brought up here, in general REST advocates the following concept:

 

GET -- for Getting information about something.

POST -- for creating a new item

PUT -- for modifying an existing item

DELETE -- for removing an item.

 

Since these items are orders, it seems like they follow the REST conventions although it's unclear what the restful endpoint that identifies the order would be just from your example.

 

It looks like you have something like:

 

foo.com/order#

 

Where I'd expect something like:

 

foo.com/order/order#

 

If you use chrome, I've found this plugin provides a nice alternative to testing things with command line curl:

 

https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm?hl=en

[QuickOldCar]

That postman looks useful.

 

Easier to read about it here.

http://www.getpostman.com/

[gizmola]

That postman looks useful.

 

Easier to read about it here.

http://www.getpostman.com/

Yeah it has a macro capability which is really nice when you are testing against multiple server environments. You can setup your routes to use variables, and reference endpoints or header variables that way.

 

And of course the main advantage is you can save the routes into groups. Here's one example I have:

 

{{host}}{{port}}{{con}}/member/account

Then you create an environment and go in and setup those variables, so for example you might have my-local-api env:

 

host  localhost
port  :4066
con   /app_dev.php
authkey   c342oiu4o2u3.... etc

And wherever there are parameters or header variables you need to set you can use the environment variables, so in the routes or in a header variable like our-api-token {{token}}

 

Really a nice tool!