https://github.com/adamculp/api-consumer

Wrapper class to consume APIs through GET using Curl. Based on PHP 7.3. (created to consume some APIs)
https://github.com/adamculp/api-consumer

api-consumer curl php rest-client

Last synced: about 1 month ago
JSON representation

Wrapper class to consume APIs through GET using Curl. Based on PHP 7.3. (created to consume some APIs)

• Host: GitHub
• URL: https://github.com/adamculp/api-consumer
• Owner: adamculp
• License: bsd-3-clause
• Created: 2012-10-05T01:05:41.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2019-02-24T00:34:54.000Z (almost 6 years ago)
• Last Synced: 2024-08-07T13:59:50.064Z (5 months ago)
• Topics: api-consumer, curl, php, rest-client
• Language: PHP
• Homepage:
• Size: 37.1 KB
• Stars: 8
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![CircleCI](https://circleci.com/gh/adamculp/api-consumer.svg?style=svg)](https://circleci.com/gh/adamculp/api-consumer)

About

-----

Simple PHP 7.3 class to consume an API through GET using Curl. (created to consume APIs, and could be used for other

things) Methods build API URL params, connection url, and parse expected JSON response.

In the future I intend to add the possibility of an XML return as well, and may even break out the limited Curl

functionality to another class, or simply use Guzzle.

Requirements

------------

Requires PHP version 7.3 if namespaces are desired.

Installation

------------

This class can be used directly from a GIT clone:

    git clone https://github.com/adamculp/api-consumer.git

You could also download the ApiConsumer package and move the directory to a desired location where your scripts can then

call it.

Alternatively you could simply copy the ApiConsumer.php file to a desired location and call it that way as well.

Non-Composer Usage

------------------

This class was written using namespaces available via PHP 5.3+, and if left unchanged would be used in the following manner:

NOTE: This class contains information needed to utilize a certain Mashery API at Active.com, but you can change the URL

and params as needed for other APIs that return JSON.

    require_once 'path/to/src/ApiConsumer/Consumer.php';

    use ApiConsumer\Consumer;

    

    $apiConsumer = new Consumer();

    $url = 'http://api.amp.active.com/search?';

    

    $apiConsumer->setUrl($url);

    

    $meta = 'meta:channel=Running+meta:startDate:daterange:today..' . date('Y-m-d', strtotime('next month'));

    $params = array(

                    'k' => 'ultra+marathon',

                    'v' => 'json',

                    'l' => 'Florida',

                    'r' => '25',

                    's' => 'date_asc',

                    'api_key' => '{Add API Key Here}',

                    'm' => $meta

                );

                

    $options = array(); // key=>value pairs can be added here to alter the curl call

    

    $apiConsumer->setParams($params);

    

    $apiConsumer->setOptions($options);

    

    $apiConsumer->setResponseType('json');

    $apiConsumer->setCallType('get');

    

    $result = $apiConsumer->doApiCall();

Composer Usage

------------------

After either installing Composer using one of the two methods shown at http://getcomposer.org the composer.json would

look like:

    {

        "require": {

            "adamculp/api-consumer": "dev-master"

        }

    }

Then you'll need to alter the require_once in the sample above to point to the Composer autoload instead of to the class

itself.

    require_once 'vendor/autoload.php'; // to include the composer autoloader

From there you can use the $result array as you see fit.

Please use the /api-consumer/index.php as a working example (minus the API key) of how the class can be included and used.