salestools/php-api-client

This package is abandoned and no longer maintained. No replacement package was suggested.

PHP lib for making API calls

dev-master 2018-08-29 10:43 UTC

Requires

• php: >=5.3.0

Suggests

• ext-curl: PHP curl lib for making calls

0BSD

• salestools

• php
• api
• client
• calls

README

PHP lib for making API calls

Installation

Run:

composer require "salestools/php-api-client" "~1.0"

Usage

As client

<?php

$client = new \salestools\api\Client([
    'baseUri' => 'https://google.com/api/',
    'timeout' => 30,
    'defaultHeaders' => [],
    'defaultQueryParams' => [],
]);

// Simple example: get index page content
$content = $client->get('http://example.com/index.php')->send()->body();

// Make request to baseUri + 'users'
$request = $client->post('users')
    ->setQueryParam('id', 123) // Single param
    ->setQueryParam(['name' => 'Jack', 'company' => 'Google']) // Params array
    ->setPostParam('password', '12345') // Single POST param
    ->setPostParam(['email' => 'example@com', 'location' => 'London']) // POST params array
    ->setHeaderParam('Connection', 'Keep-Alive') // Header value
    ->setHeaderParam(['Accept' => 'image/gif', 'Some-Custom' => 'value']); // Headers array

// Resets
$request->queryParams = []; // Reset query params
$request->formParams = []; // Reset post params
$request->headerParams = []; // Reser headers

// Submit request and get Response object
$response = $request->send();


// Without client instance
// As static class
$response = \salestools\api\ApiRequest::get('http://example.com/index.php');
$response = \salestools\api\ApiRequest::post('http://example.com/index.php');
$response = \salestools\api\ApiRequest::put('http://example.com/index.php');
$response = \salestools\api\ApiRequest::delete('http://example.com/index.php');


// Response attributes
$statusCode = $response->statusCode(); // Response code: 200, 201, 204, etc...
$bodyText = $response->body(); // Content
$bodyJson = $response->json(); // Json decoded content
$headerParams = $response->headers(); // Headers array
$headerValue = $response->headerValue('Encoding', 'Default value'); // Some header value