Accessing a json api with php

Question

I'm trying to learn how I can interface with a json api. In the documentation they give me a curl example:

If I run this as a command it works fine, gives me my data in a json format.

I thought I was on the right track with this: PHP + curl, HTTP POST sample code?

but apparently not as I can't figure out what to do with the -H portion of this command.

curl -H "APIKey:My:ApI;key;" -H "Content-Type:.../json" "https://urlofapp.com/API/GetTransaction" -d "{ 'CustomerID':'12345','EndDate':'2018-12-31','StartDate':'2018-01-01'}" > test.json

Trying to get the result into an array that I can sum and show a total of their orders for the year.

From the link I provided above I was trying to start with this:

// set post fields
$post = [
'CustomerID' => 12345,
'StartDate' => 2018-01-01,
'EndDate'   => 2018-12-31,
];

$ch = curl_init('https://urlofapp.com/API/GetTransaction');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);

// execute!
$response = curl_exec($ch);

// close the connection, release resources used
curl_close($ch);

// do anything you want with your response
var_dump($response);

The H part in the command stands for HTTP header.

Pablo
– Pablo

2019-01-19 05:35:03 +00:00
Commented Jan 19, 2019 at 5:35 — Pablo
– Pablo, Commented Jan 19, 2019 at 5:35
Show us your code. H is HTTP header.

Set Kyar Wa Lar
– Set Kyar Wa Lar

2019-01-19 05:36:14 +00:00
Commented Jan 19, 2019 at 5:36 — Set Kyar Wa Lar
– Set Kyar Wa Lar, Commented Jan 19, 2019 at 5:36
what is your code so far? Can't help without code.

Pete Houston
– Pete Houston

2019-01-19 05:55:02 +00:00
Commented Jan 19, 2019 at 5:55 — Pete Houston
– Pete Houston, Commented Jan 19, 2019 at 5:55
I have updated with what I have so far.

user3512531
– user3512531

2019-01-19 06:00:52 +00:00
Commented Jan 19, 2019 at 6:00 — user3512531
– user3512531, Commented Jan 19, 2019 at 6:00

Praneeth Nidarshan · Accepted Answer · 2019-01-19 06:09:22Z

3

The -h command refers the header.

Try below code,

// Generated by curl-to-PHP: http://incarnate.github.io/curl-to-php/
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://urlofapp.com/API/GetTransaction');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{ 'CustomerID':'12345','EndDate':'2018-12-31','StartDate':'2018-01-01'}");
curl_setopt($ch, CURLOPT_POST, 1);

$headers = array();
$headers[] = 'Apikey: My:ApI;key;';
$headers[] = 'Content-Type: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close ($ch);

I used below to convert the curl command to PHP script,

https://incarnate.github.io/curl-to-php/

Hope it would be useful.

answered Jan 19, 2019 at 6:09

Praneeth Nidarshan

1,70415 silver badges21 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Blane Townsend Over a year ago

To provide some context on -H "Content-Type:.../json". The reason Praneeth put "application/json" as this content type is because you are passing json encoded data to this API (your POST data). If you were to pass XML encoded data you would want to set this to "Content-Type: application/xml". This helps the API know how to parse your data.

Joel Beckham · Accepted Answer · 2019-01-19 06:32:04Z

1

Dealing with curl directly usually ends up being a pain. There are a number of libraries that can help making calls like that much simpler.

Here are a few:

Simple and straighforward: http://requests.ryanmccue.info/
Has everything you could ever possibly want: https://github.com/guzzle/guzzle

answered Jan 19, 2019 at 6:32

Joel Beckham

18.7k3 gold badges38 silver badges58 bronze badges

Collectives™ on Stack Overflow

Accessing a json api with php

2 Answers 2

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related