PHP download

Download the PHP package livechat/api-client-php without Composer

On this page you can find all versions of the php package livechat/api-client-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download livechat/api-client-php
More information about livechat/api-client-php
Files in livechat/api-client-php

Vendor livechat
Package api-client-php
Short Description Enables PHP applications to communicate with the LiveChat API.
License MIT
Homepage http://developer.livechatinc.com

Keywords rest api

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Informations about the package api-client-php

LiveChat API Client

PHP client for connecting to the LiveChat REST API.

Documentation

To find out more, visit the official LiveChat REST API documentation.

Previous version of LiveChat API Client.

Requirements

PHP 5.3 or greater
cUrl extension enabled

Authentication to the API occurs via HTTP Basic Auth. Provide your:

login
API key

More information: https://developers.livechatinc.com/rest-api/#authentication

Installation

Composer

$ composer require livechat/api-client-php "@dev"

Or, set up dev as minimum-stability in your composer.json:

    "minimum-stability": "dev"

Then:

 $ composer require livechat/api-client-php
 $ composer update

Execute tests

This operation requires PHPUnit installed.

 $ phpunit

Basic usage

<?php

require_once __DIR__ . '/vendor/autoload.php';

use LiveChat\Api\Client as LiveChat;

$LiveChatAPI = new LiveChat('%login%', '%apiKey%');
$agents = $LiveChatAPI->agents->get();

Available methods

Methods returns stdClass (parsed JSON response).

Agents

Agents REST API documentation.

$LiveChatAPI->agents->get($login = null)
$LiveChatAPI->agents->add(array $vars)
$LiveChatAPI->agents->update($login, array $vars)
$LiveChatAPI->agents->delete($login)

Canned responses

Canned responses REST API documentation.

$LiveChatAPI->cannedResponses->get($group = 0)
$LiveChatAPI->cannedResponses->getSingleResponse($id)
$LiveChatAPI->cannedResponses->addNewResponse($text, $tags)
$LiveChatAPI->cannedResponses->updateResponse($id, $text, $tags)
$LiveChatAPI->cannedResponses->deleteResponse($id)

Chat archives

Archives REST API documentation.

$LiveChatAPI->chats->get($params = array())
$LiveChatAPI->chats->getSingleChat($chatId)
$LiveChatAPI->chats->updateTags($id, array $vars)

Goals

Goals REST API documentation.

$LiveChatAPI->goals->markAsSuccessful($goalId)

Groups

Groups REST API documentation.

$LiveChatAPI->groups->get($group = 0)
$LiveChatAPI->groups->update($id, array $vars)
$LiveChatAPI->groups->add(array $vars)
$LiveChatAPI->groups->delete($id)

Reports

Reports REST API documentation.

$LiveChatAPI->reports->get($type, array $params = array())

Status

Status REST API documentation.

$LiveChatAPI->status->get($group = 0)

Tickets

Tickets REST API documentation.

$LiveChatAPI->tickets->get(array $params = array())
$LiveChatAPI->tickets->getSingleTicket($ticketId)
$LiveChatAPI->tickets->add(array $vars)
$LiveChatAPI->tickets->updateTags($id, array $vars)

Visitors

Visitors REST API documentation.

$LiveChatAPI->visitors->get(array $params = array())

Webhooks

Webhooks REST API documentation.

$LiveChatAPI->webhooks->get()
$LiveChatAPI->webhooks->add(array( "event_type" => "chat_started", "data_types" => array( "chat", "visitor" ), "url" => "http://www.shoeshop.com/webhook", ))
$LiveChatAPI->webhooks->delete('622d3950eecea8bb5f8c26f20c76ee2e')

To do

Tests for models
Add all supported API methods

All versions of api-client-php with dependencies

PHP Build Version

Package Version

Version v1.1.1 Release 15. Jan 2016
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of api-client-php from vendor livechat

Requires php Version >=5.3.0

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package livechat/api-client-php contains the following files

Loading the files please wait ...