Webservice 8.1.6

Webservice

Introduction

Webservice (previously Entry API) is a module that creates a REST/XMLRPC/SOAP server under the hood of the ExpressionEngine CMS. It support out of the box a Entry API with support for third party addons (Grid, Matrix, Playa, Relationship etc...). Additional you can extend the API with other APIs like;Comments, Categories, Channels etc...

Installation

Prerequisites

Make sure your system meets the minimum requirements:

• ExpressionEngine 2.6 or later
• PHP 5.3
• PHP Soap extension (Only needed for the SOAP Services)

Installation Instructions

1. Upload ee2/system/third_party/webservice to system/expressionengine/third_party/
2. install the moduel in Add-Ons → Modules
3. While installing, choose to install the extension as well
4. Ensure that Extensions are enabled in Add-Ons → Extensions

Summary of features

• CRUD Entries
• Search Entries
• CRUD Catagory Group
• CRUD Catagory
• CRUD Channels
• Save files through the services
• Error and/or usage Logging.
• Testing tool

The settings

Preference Setting

License key The license key given by Devot-ee

Report Statistics

Report anonymously PHP and EE versions

Free API(s)

This are methods that are free to use, without any login

IP Blacklist

Blacklist an IP

Url Trigger

The trigger when calling the webservice

Super Admin API Key

The super admin API key. With this key you can login as super admin.

Rest output header

Set the output header for the rest service, handy in some cases with "access control allow origin" issues.

Strict site_id

Handle strict usage for site_ids

Debug

Enable the debug mode

API Keys

The API Keys are designed to give easy access through an API Key.

Api Keys can be added on the member API page.

The follwing appreach can be archieved for example by the REST service

http://domain.com/webservice/rest/read_entry?auth[api_key]&data[entry_id]=1

Creating Members for the API

1. Go to the module home
2. Click on 'Add member'
3. Select the member
4. Select the connection type
5. Choose your API(s)
6. Ss the server active
7. Set the logging
8. Set the debug mode
9. Save the channel settings
10. Now you can connect with the url (shown on you details page) of the service.

Logging

Each call can be logged via the logging manager that comes with the Webservice module.

The setting can be found on the member detail page

The overview page can be found in the menu of the Webservice module

Testing Tool

The Webservice module will also comes with a fully featured testing tool to test your API. The Testing Tool is located within the CP of the Webservice module

Navigate to the CP of the Webservice module and click on 'Testing tools'

When you clicked on the Testing Tools button, you will navigated to the start page where you have the option for an API.

By selecting one of this API`s, you will go to the testing page for this specific API. For example the Entry API

By the Entry API you will also notice that there is an extra field "extra", this field will accept an PHP array to extend the fields. In case you want to test your own custom fields.

Adding an Playa field.

array(
    'playa' => array(
        2,3,4,5
    ),
);

You will also notice that all services can be tested, be awere that you need the SOAP extension for the SOAP API.

Urls

The following urls are used for the service

XMLRPC

• domain.com/index.php/webservice/xmlrpc

SOAP

• domain.com/index.php/webservice/soap (service only)
• domain.com/index.php/webservice/soap?wsdl (wsdl only)

REST

• domain.com/index.php/webservice/rest/<method_name>/<output>?<get_values>
• method_name: are methods like create_entry delete_entry etc.
• output: indicates the output. (json php xml)
• get_values: all post values can also be passed as an array of get values. (?auth[username]=test&auth[password]=test&data[title]=test&data[channel]=news)

Auth via header in a REST request via the following key for auth: "webserviceauth[fieldname]" data: "webservice_data[field_name]"

User rights

All kind of rights and restrictions can as usually be managed in the Control Panel for the membergroups. This module will grab it from there. There will be also a check on the fields that are required.

API Adman

Compatibility

• EE2
• EE3

Installation

1. Copy the files to the system/expressionengine/third_party dir
2. Enable the API from within the Webservice Module

Methods

show_adman

Response

Array
(
    [group_id] => 1
    [group_title] => 1
    [group_url] => http://google.nl
    [site_id] => 1
    [adgroup_id] => 1
    [ad_id] => 1
    [sort_order] => 0
    [ad_title] => just a title
    [ad_image] => url_to_image.png
    [ad_remote_image] => null
    [ad_url] => http://google.nl
    [ad_alt] => just an alt text
    [ad_text] => Just a text
    [ad_start] => 2014-08-23 00:00:00
    [ad_end] => 2015-08-23 00:00:00
    [ad_width] => 0
    [ad_height] => 0
    [ad_max_click] => 9999
    [ad_max_impression] => 99999
    [client_id] => 1
    [ad_impression] => 12
    [ad_clicks] => 0
    [ad_cpc] => 0.00
    [total_results] => 1
    [is_flash] => 0
)

Hooks

webservice_show_adman_start

(added in v3.5)

ee()->extensions->call('webservice_create_category_start', $post_data);

webservice_show_adman_end
(added in v3.5)

ee()->extensions->call('webservice_create_category_end', $return_data);

API Auth

Compatibility

• EE2
• EE3

Installation

The Auth API comes natively with Webservice module.

Methods

authenticate_username

Request

$client = new SoapClient('your-domain.com/index.php/webservice/soap?wsdl', array('trace' => 1));

$session_data = $client->authenticate_username('testUsername', 'testPassword');

print_r($session_data);

Request (new session)

$client = new SoapClient('your-domain.com/index.php/webservice/soap?wsdl', array('trace' => 1));

$session_data = $client->authenticate_username('testUsername', 'testPassword', 'yes');

print_r($session_data);

API Category

Compatibility

• EE2
• EE3

Installation

1. Copy the files to the system/expressionengine/third_party dir
2. Enable the API from within the Webservice Module

Methods

create_category

Request

Array
(
    [group_id] => 1
    [parent_id] => 1 
    [cat_name] => test category
    [cat_description] => test description
)

read_category

Request

Array
(
    [cat_id] => 2
)

update_category

Request

Array
(
    [cat_id] => 1
    [group_id] => 1
    [parent_id] => 1 
    [cat_name] => test category
    [cat_description] => test description
    [cat_order] => 3
)

delete_category

Request

Array
(
    [cat_id] => 2
)

Hooks

webservice_create_category_end

(added in v2.2)

ee()->extensions->call('webservice_create_category_end', $category_id);

webservice_read_category_end

(added in v2.2)

ee()->extensions->call('webservice_read_category_end', $category_data);

webservice_update_category_end

(added in v2.2)

ee()->extensions->call('webservice_update_category_end', $category_data);

webservice_delete_category_end

(added in v2.2)

ee()->extensions->call('webservice_delete_category_end', '');

API Category Group

Compatibility

• EE2
• EE3

Installation

1. Copy the files to the system/expressionengine/third_party dir
2. Enable the API from within the Webservice Module

Methods

create_category_group

Request

Array
(
    [group_name] => Test group
    [exclude_group] => 0
    [field_html_formatting] => all
    [can_edit_categories] => 6
    [can_delete_categories] => 6
)

read_category_group

Request

Array
(
    [group_id] => 2
    [show_children] => yes
)

update_category_group

Request

Array
(
  [group_id] => 14  
  [group_name] => Test group
  [exclude_group] => 0
  [field_html_formatting] => all
  [can_edit_categories] => 6
  [can_delete_categories] => 6
)

delete_category_group

Request

Array
(
  [group_id] => 14  
)

Hooks

webservice_create_category_group_end

(added in v2.2)

ee()->extensions->call('webservice_create_category_group_end', $category_group_id);

webservice_read_category_group_end

(added in v2.2)

ee()->extensions->call('webservice_read_category_group_end', $category_group_data);

webservice_update_category_group_end

(added in v2.2)

ee()->extensions->call('webservice_update_category_group_end', $category_group_data);

webservice_delete_category_group_end

(added in v2.2)

ee()->extensions->call('webservice_delete_category_group_end', '');

API Category

Compatibility

• EE2
• EE3

Installation

1. Copy the files to the system/expressionengine/third_party dir
2. Enable the API from within the Webservice Module

Methods

create_channel

Request

Array
(
    [site_id] => 1
    [channel_title] => Test Channel
    [channel_name] => test_channel
)

read_channel

Request

Array
(
    [channel_id] => 1
)

update_channel

Request

Array
(
    [channel_id] => 1
    [channel_title] => Test Channel
    [channel_name] => test_channel
)

delete_channel

Request

Array
(
    [channel_id] => 1
)

Hooks

webservice_create_channel_end

(added in v3.0)

ee()->extensions->call('webservice_create_channel_end', $channel_id);

webservice_read_channel_end

(added in v3.0)

ee()->extensions->call('webservice_read_channel_end', $channel_read_data);

webservice_update_channel_end

(added in v3.0)

ee()->extensions->call('webservice_update_channel_end', $channel_update_data);

webservice_delete_channel_end

(added in v3.0)

ee()->extensions->call('webservice_delete_channel_end', $channel_id);

API Comment

Compatibility

• EE2

Installation

1. Copy the files to the system/expressionengine/third_party dir
2. Enable the API from within the Webservice Module

Methods

create_comment

Request

Array
(
  [comment] => a nice comment
  [member_id] => 1
)

read_comment

Request

Array
(
  [comment_id] => 43
)

create_comment

Request

Array
(
  [comment_id] => 43
  [comment] => an update for the comment
)

Currently not available: Assign comment to another entry ID

delete_comment

Request

Array
(
  [comment_id] => 43
)

API Config

Compatibility

• EE2
• EE3

Installation

1. Copy the files to the system/expressionengine/third_party dir
2. Enable the API from within the Webservice Module

Methods

read_config

Request

Array
(
  [key] => url_title
)

API Entry

Compatibility

• EE2
• EE3

Installation

The Auth API comes natively with Webservice module.

Methods

create_entry

Request

Array
(
  [status] => Closed
  [title] => Test entry
  [sticky] => y
  [allow_comments] => n

  //custom fields
  [news_body] => This is a full body text
  [news_extended] => This is some small text

  [category] => Array(
    1,2,3,4
  )

  [custom_file_field] => Array(
      'filedata' => base64_encode(file_get_contents('path_to_image.jpg')),
    'filename' => 'filename.jpg',
    'dir_id' => 6
  )
)

read_entry

See search_entry method because of v3.5 they are the same

update_entry

Request

Array
(
  [status] => Closed
  [title] => Test entry
  [sticky] => y
  [allow_comments] => n

  //custom fields
  [news_body] => This is a full body text
  [news_extended] => This is some small text
)

delete_entry

Request

Array
(
    [entry_id] => 14
)

search_entry

The search mechanism is identical to the search method from the Channel module

Request

Array
(
  [channel] => news_channel
  [limit] => 25
  [offset] => 5
)

Hooks

webservice_create_entry_start

(added in v3.2.1)

$entry_data = ee()->extensions->call('webservice_create_entry_start', $entry_data);

webservice_create_entry_end

(added in v2.2)

ee()->extensions->call('webservice_create_entry_end', $entry_id, $post_data);

webservice_read_entry_start

(added in v3.2.1)

$entry_data = ee()->extensions->call('webservice_read_entry_start', $entry_data);

webservice_read_entry

(added in v4.4.2)
Runs after the validation

$entry_data = ee()->extensions->call('webservice_read_entry', $entry_data, $post_data);

webservice_read_entry_end

(added in v2.2)

$entry_data = ee()->extensions->call('webservice_read_entry_end', $entry_data);

webservice_update_entry_start

(added in v3.2.1)

$entry_data = ee()->extensions->call('webservice_update_entry_start', $entry_data);

webservice_update_entry

(added in v4.4.2)
Runs after the validation

$entry_data = ee()->extensions->call('webservice_update_entry', $entry_data, $post_data);

webservice_update_entry_end

(added in v2.2)

ee()->extensions->call('webservice_update_entry_end', $entry_data, $post_data);

webservice_delete_entry_start

(added in v3.2.1)

$entry_data = ee()->extensions->call('webservice_delete_entry_start', $entry_data);

webservice_delete_entry_end

(added in v2.2)

ee()->extensions->call('webservice_delete_entry_end', '');

webservice_modify_search

(added in v4.0)
With this hook you can extend the search by your own. Just make sure the hook will return an array of entry_ids.

$entry_ids = ee()->extensions->call('webservice_search_entry_per_entry', $values, $fields);

webservice_search_entry_per_entry

(added in v3.2)

$entry_data = ee()->extensions->call('webservice_search_entry_per_entry', $entry_data);

webservice_search_entry_per_entry

(added in v3.2)

$entry_data = ee()->extensions->call('webservice_search_entry_per_entry', $entry_data);

webservice_search_entry_start

(added in v3.2.1)

$entry_data = ee()->extensions->call('webservice_search_entry_start', $entry_data);

webservice_search_entry_end

(added in v2.2)

$entry_data = ee()->extensions->call('webservice_search_entry_end', $entry_data);

webservice_entry_row

(added in v3.5)
WIll be called when reading an entry

$entry_data = ee()->extensions->call('webservice_entry_row', $entry_data);

webservice_read_entry_matrix

(added in v4.0)

ee()->extensions->call('webservice_read_entry_matrix', $value, $col_settings);

webservice_read_entry_grid

(added in v4.0)

ee()->extensions->call('webservice_read_entry_grid', $value, $col_settings);

Examples

Create entry SOAP

<?php

//file data
$image = 'file.jpg';
$file = base64_encode(file_get_contents($image));

$client = new SoapClient('your-domain.com/index.php/webservice/soap?wsdl', array('trace' => 1));

$reponse = $client->create_entry(array(
    'username' => 'testUsername',
    'password' => 'testPassword'
), array(
    'channel_name' => 'news',
    'status' => 'Open',
    'title' => 'test entry',
    'sticky' => 'y',
    'allow_comments' => 'n',
    'category' => '1|2|3',
    'filefield' => array(
        'filedata' => $file,
        'filename' => 'file.jpg',
        'dir_id' => 6
    )
));
?>

Create entry REST (with an image)

<?php
$url = 'http://ee312.local/index.php/webservice/rest/create_entry';

//set POST variables
$fields = array(
    'auth' => array(
        'username' => 'admin',
        'password' => 'test123',
    ),
    'data' => array(
        'channel_name' => 'test_channel',
        'title'    => 'Test entry',
    )
);

//open connection
$ch = curl_init();
//set the url, number of POST vars, POST data
curl_setopt($ch,CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST, count($fields));
curl_setopt($ch,CURLOPT_POSTFIELDS, urldecode(http_build_query($fields)));
//execute post
$result = curl_exec($ch);
//close connection
curl_close($ch);

?>

Create entry XMLRPC

<?php
//http://gggeek.github.io/phpxmlrpc/
include("xmlrpc/xmlrpc.inc");

$c = new xmlrpc_client('http://domain.com/index.php/webservice/xmlrpc');

$x = new xmlrpcmsg('create_entry', array(
    php_xmlrpc_encode(array(
        'username' => 'admin',
        'password' => 'test123',
    )),
    php_xmlrpc_encode(array(
        'channel_name' => 'test_channel',
        'title'    => 'Test entry',
    )),
));

$c->return_type = 'phpvals';
$r =$c->send($x);
?>

API Mailing List

Compatibility

• EE2

Installation

1. Copy the files to the system/expressionengine/third_party dir
2. Enable the API from within the Webservice Module

Methods

create_mailinglist

Request

Array
(
    [list_name] => test_mailinglist
    [list_title] => Test Mailinglist
)

read_mailinglist

Request

Array
(
    [list_id] => 2
)

update_mailinglist

Request

Array
(
  [list_id] => 14  
  [list_name] => test_group
)

delete_mailinglist

Request

Array
(
  [list_id] => 14  
)

create_subscription

Request

Array
(
  [list_id] => 14  
  [email] => test@example.com  
)

delete_subscription

Request

Array
(
  [list_id] => 14  
  [email] => test@example.com  
)

Hooks

webservice_create_mailinglist_start

(added in v1.0)

$post_data = ee()->extensions->call('webservice_create_mailinglist_start', $post_data);

webservice_create_mailinglist_end

(added in v1.0)

ee()->extensions->call('webservice_create_mailinglist_end', $list_id);

webservice_read_mailinglist_start

(added in v1.0)

$post_data = ee()->extensions->call('webservice_read_mailinglist_start', $post_data);

webservice_read_mailinglist_end

(added in v1.0)

ee()->extensions->call('webservice_delete_category_group_end', $list_id);

webservice_update_mailinglist_start

(added in v1.0)

$post_data = ee()->extensions->call('webservice_update_mailinglist_start', $post_data);

webservice_update_mailinglist_end

(added in v1.0)

ee()->extensions->call('webservice_update_mailinglist_end', $list_id);

webservice_delete_mailinglist_start

(added in v1.0)

$post_data = ee()->extensions->call('webservice_delete_mailinglist_start', $post_data);

webservice_delete_mailinglist_end

(added in v1.0)

ee()->extensions->call('webservice_delete_mailinglist_end', $list_id);

webservice_create_subscription_start

(added in v1.0)

$post_data = ee()->extensions->call('webservice_create_subscription_end', $post_data);

webservice_create_subscription_end

(added in v1.0)

ee()->extensions->call('webservice_create_subscription_end', $list_id);

webservice_delete_subscription_start

(added in v1.0)

$post_data = ee()->extensions->call('webservice_delete_subscription_start', $post_data);

webservice_delete_subscription_end

(added in v1.0)

ee()->extensions->call('webservice_delete_subscription_end');

API Member

Compatibility

• EE2
• EE3

Installation

1. Copy the files to the system/expressionengine/third_party dir
2. Enable the API from within the Webservice Module

Methods

create_member

Request

Array
(
    [group_id] => 2
    [username] => test user
    [screen_name] => Test User
    [password] => du*7e2O
    [email] => info@test.com
)

read_member

Request

Array
(
    [member_id] => 2
)

update_member

Request

Array
(
    [member_id] => 2
    [msn_im] => jan0292
)

Limitation:

Password and username update has been disabled due some EE complexity

delete_member

Request

Array
(
    [member_id] => 2
)

Hooks

the default EE hooks are being used.

API Member Group

Compatibility

• EE2
• EE3

Installation

1. Copy the files to the system/expressionengine/third_party dir
2. Enable the API from within the Webservice Module

Methods

create_member_group

Request

Array
(
    [site_id] => 1
    [group_title] => Test group
    [can_view_offline_system] => y
    [can_search] => n
)

read_member_group

Request

Array
(
    [group_id] => 2
)

update_member_group

Request

Array
(
    [group_id] => 2
    [can_send_email] => n
)

delete_member_group

Request

Array
(
    [group_id] => 2
)

Hooks

the default EE hooks are being used.

API Template group

Compatibility

• EE3

Installation

1. Copy the files to the system/expressionengine/third_party dir
2. Enable the API from within the Webservice Module

Methods

create_template_group

Request

Array
(
    [site_id] => 1
    [group_name] => Test group
    [is_site_default] => n
)

read_template_group

Request

Array
(
    [group_id] => 2
)

update_template_group

Request

Array
(
    [group_id] => 2
    [is_site_default] => y
)

delete_template_group

Request

Array
(
    [group_id] => 2
)

Hooks

Default Parameters

All API methods, except the Auth API, will accept a default set of values. For example i will take the API method create_entry.

The accpeted parameters are always 2 arrays. The first one is the auth array and the second one is the data array.

Auth array

The auth array has a structure like this:

Array
(
  [username] => test
  [password] => testPassword

  [api_key] => y63idklo93
)

The username and password belong together, api_key (defined in the cp) are standalone vars.

Data structure

the data structure is a also a associative array, and wil lbe described on the method page.

Extensions

Parent Relationship/Playa

The Relationship/Playa extension will add a new value to the read_entry and search_entry that include the parents of the relationship child.

[ext_playa_parents] => [{"rel_id":"6","parent_entry_id":"5","parent_field_id":"3","order":"0"},{"rel_id":"7","parent_entry_id":"3","parent_field_id":"3","order":"0"}]

[ext_relationship_parents] => [{"rel_id":"1","parent_entry_id":"5","parent_field_id":"4","order":"1"},{"rel_id":"2","parent_entry_id":"3","parent_field_id":"4","order":"1"}]

Structure

The Structure extension will add some extra structure data to the entry array.

[structure] => {"hide_from_nav":"n","hidden":"n","listing_channel_id":"2","listing_channel_name":"news","listings_total":0}

Relationship in Grid/Matrix (DISCONTINUED, native implement)**

Read/convert your Relationship out of an Matrix/Grid field and get the actual entry instead.

Relationship (DISCONTINUED, native implement)**

Convert your relationship field (also Playa) with real entry data instead of entry_ids

morematrixrelations**

Convert the moreMatrixRelations field in an entry

Simple S3 upload Matrix/Grid field**

Read your Simple S3 upload out of an Matrix/Grid field

Fieldtype API

The Webservice module provide a set of API methods to make your fieldtype compatible. In order to develop such funtionality, you have to create a fieldtype first. When you`re done, you can add some of the following functions below.

If your Fieldtype only save the data to the channel_data table, you don`t have to do anything. The Webservice module will support this out of the box. However, if your data need some specific data structure, you have to use this API to make your field compatible with the Webservice module.

You will mostly need the webservice_save webservice_validate and webservice_pre_process

• In the webservice_save function you can strucutre your data, like on the publish page (see the matrix file as example).
• The webservice_validate will be your validate function which called before the webservice_api_save function. On false, the data will not be processed.
• And the webservice_pre_process can be used to strucutre your data on read or search.

As an example of how Matrix data can be submitted with the Webservice module:

'matrix_field' => array(
    'rows' => array(
        array(
            'cell_1' => 'row 1',
            'cell_2' => 'row 11',
        ),
        array(
            'cell_1' => 'row 2',
            'cell_2' => 'row 22'
        )
    ),
    'trigger_revisions' => 1
);

This data structure will be converted with the fieldtype API to a correct data structure.

Tag Parameters

Below are the Tag Parameters. Those parameters can be used in the tag described above

field_type

Holds the field type

$this->field_type = '';

field_name

Holds the field name

$this->field_name = '';

field_id

Holds the field id

$this->field_id = 0;

field_data

Holds an array of the field data

$this->field_data = array();

field_settings

Holds an array of the field settings

$this->field_settings = array();

channel_settings

Holds the channel settings

$this->channel_settings = array();

webservice_save()

Preps the data for saving. or you can save your data to your own fields instead.

$data : null
$is_new : null
$entry_id : 0
return : string

public function webservice_save($data = null, $is_new = false, $entry_id = 0)
{
    return $data;
}

webservice_validate()

Validates the field input.

$data : null
$is_new : null
return : bool

public function webservice_validate($data = null, $is_new = false)
{
        //$this->validate_error = '';
    return true;
}

webservice_post_save()

Handles any custom logic after an entry is saved.

$data : null
$inserted_data : array()
$entry_id : 0
return : void

public function webservice_post_save($data = null, $inserted_data = array(), $entry_id = 0) 
{

}

webservice_pre_process()

Preprocess the data to be returned. Convert any complex data to a nice string or array. The Webservice will convert any Array to a json string.

$data : null
$free_access : false
$entry_id : 0
return : mixed

public function webservice_pre_process($data = null, $free_access = false, $entry_id = 0) 
{
    return $data;
}

webservice_delete()

Delete field data. Here you can add some additional deletion for your own fieldtype.

$data : null
$entry_id : 0
return : void

public function webservice_delete($data = null, $entry_id = 0) 
{
}

Search in Grid/Matrix cells

The Webservice module has also support for searching in Grid or Matrix cells.

​Example Rest

http://domain.com/webservice/rest/search_entry?auth[api_key]=27dd39e*7d&data[grid][cell_1]=test

As you can see, you only have to use a multi dimensional array to do this.

Compatible Addons

Out of the box the the Webservice module support all fieldtypes that save their data to the exp_channel_data table. Other addons that using their own table or do something with files for example are not supported, unless they listed below.

If you found an addon that has no support for the Webservice, you can send me an email.

Grid

Natively: The following syntax is needed.

array(
    'grid' => array(
        'rows' => array(
            array(
                'cell_1' => 'row 1',
                'cell_2' => 'row 11'
            ),
            array(
                'cell_1' => 'row 2',
                'cell_2' => 'row 22'
            ),
        ),
    ),
);

Relationship

Natively: The following syntax is needed.

array(
    'relationship' => array(
        2,3,4,5
    ),
);

Matrix

Natively: he following syntax is needed.

array(
    'matrix' => array(
        'rows' => array(
            array(
                'cell_1' => 'row 1',
                'cell_2' => 'row 11'
            ),
            array(
                'cell_1' => 'row 2',
                'cell_2' => 'row 22'
            ),
        ),
    ),
);

Playa

Natively: The following syntax is needed.

array(
    'playa' => array(
        2,3,4,5
    ),
);

Zoo Visitor

Natively: The following syntax is needed.

On update, you can avoid some values because the Webservice module detect the member based on the entry_id

array(
    'member_account' => array(
        'email' => 'test@test.com',
        'username' => 'John Doe',
        'password' => 'test123',
        'screen_name' => 'John Doe',
        'group_id' => '4',            
    ),
);

Store

Store only adds basic support in the read/search method.

Content Elements

All fields, but not all are converted good (please make a thread here)

Changelog

5.0.0

• Added: EE3 support - Known problem: relations are removed when saving an entry without updating the relation (https://ellislab.com/forums/viewthread/248941/)
• Updated: testing tool for EE3 with a reqest tab
• Bugfix: where in some cases duplicated data is getted in the entry api

4.4.4

• Bugfix: where the log cleanup was showing an error
• Bugfix: where in some case the fieldtype parser was not loading the default class

4.4.3

• Bugfix: where old data get removed when updating an entry
• Bugfix: saving settings would not refresh the page
• Updated: header field can have multiple rows
• Updated: Disable the logging on a per user level. Logging should only be done on the settings level (Need to document this)
• Added: a max record debug/log setting to set the maximum number of records in the log table. Default is 10000

4.4.2

• Added: new hooks -> webservice_create_entry, webservice_update_entry

4.4.1

• updated: re-add navigation on the CP page

4.4.0

• Added: new CP menu
• Added: expiration_date and comment_expiration_date to the entry_api
• Updated: public methods to work with all new stuff
• Updated: alias read_entry hooks with search_entry hooks
• bugfix: where in an update, the sticky field is not present

4.3.1

• Added: status param for the entry search E.g. data[status]=Closed
• Added: new magic data keyword to search in all field ?data[search_all]=word+to+search
• Updated: output_fields are also applied to the relations

4.3

• Added: Content Elements support

4.2

• Added: EE Caching
• Added: entry sort by entry_id
• Added: output_fields param to the entry api to output specific fields
• Added: the Relationship extension inside the native methods. So the Relationship Extension has been discontinued.
• Added: cp setting to parse out the relationship data fully, or not.
• Added: row_order to the matrix and Grid fields
• Added: rte support
• Added: support for matrix/grid parsing. So the Grid/Matrix Relationship extension has been discontinued.
• Added: option to enable Matrix/Grid parsing
• Added: auth via headers via the following key for auth: "webserviceauth[fieldname]" data: "webservice_data[field_name]"
• Added: respect the "Clear all caches when entries are saved"
• Updated: matrix and grid are sorted now
• Bugfix: where empty settings where not saved
• Bugfix: where the grid/matrix was not give the correct data

4.1.3

• Added: add cat_url_title to the entry search
• Added: support for the Simple-S3-Uploader Fieldtype

4.1.2

• Added: API overview
• Added: setting field for the testing tool url
• Added: authorid, cat_id, cat_name, cat_description and cat[custom_field] params to the search_entry and read_entry method
• Bugfix: where some admin checks goes wrong
• Bugfix: where the assigned categories where removed with an update

4.1.1

• Added: stop_before param for the entry
• Added: start_on param for the entry
• Updated: remove some files that not needed
• Bugfix: undefined format when doing a post on the rest service

4.1

• Added: new metdata response field, this add metadata like ID, Limit, offset, total_resuls, absolute_results
• Added: version nummer to the apis
• Added: Show Query option in the logging (CP)
• Updated: logging saved with base64 encoding
• Updated: Make the entry_date modifiable
• Updated: Public method return messages confirm the other services
• Bugfix: in the Matrix/grid Search
• Bugfix: when there where no channels assigned, the module gives an error
• Deprecated: ID Response field, instead use the metadata field

4.0

• Added : strict site_id settings for strict site_id usage
• Added : member create notifications in the Member API
• Added : config read API
• Added : webservice_read_entry_grid and webservice_read_entry_matrix to override the result
• Added : possibility to search in Grid and Matrix fields
• Added : webservice_modify_search hook to extend the search (Webservice_gridmatrix_rel extension)
• Updated : entry limit default to 99999
• Updated : better update for third_party hooks in the entry_api_entry_row
• Updated : MSM support for the entry, category_group and channel API
• Updated: all error messages
• Changed : read_channel behave the same as search_channel
• Removed: code from the response array
• Bugfix: not authorized error in the testing tool
• Bugfix: MySql strict errors
• Bugfix : where the search method trigger an error when there is a multi array
• Bugfix : where the post_save() method not getting the data from the save() method
• Bugfix: where the entry_api shows an PHP error when there was no channel_field attached to a channel

3.5

• Bugfix : Better Fieldtype integration
• Bugfix : Undefined ee()->TMPL in the search method
• Bugfix : Where the logging was not working on a clean install of the Entry API
• Bugfix : minor
• Updated : site_id is no longer required. Is the site_id is not filled in, then we assume we have to use site_id=1
• Updated : every api will return an id(s) of the items affected
• Updated : better validate method
• Updated : APIs are standalone packages. This is for preparation that other devs can create their own api in the future.
• Updated : disabled the free apis on user level. No need for that, just only on the settings page
• Updated : searching on entries, the entry_id and channel_id are always exact match
• Changed : read_entry is accept now the same parameters as the search_entry because those are the same now
• Added : show_children=yes to the read_category_group to get also all category children
• Added : sort and orderby param in the search method of the entry
• Added : new Member API (password/username update method excluded)
• Added : Adman support for only the {exp:adman:show} method
• Added : custom API (without any services) in the testing tool
• Added : some channel data values (channel_name, channel_title) in the- search_entry
• Added : entry_id support in the search_entry method
• Added : entry_api_entry_row hook that is triggered in the read as search method on per entry row

3.4.1

• Bugfix : small MSM issues, you can now use the param site_id to select a specific site.
• Bugfix : where the error message was wrong when the entry is not exists
• Updated : reduce the queries
• Added : datetime in the logging

3.4

• Bugfix : better check on no auth data
• Bugfix : the search method throws an error on the fieldtypes
• Added : show ID in the logging
• Added : on all entry methods response message has now a key "ID" with the associated entry_id(s)
• Added : DashEE Widget for showing the latest logs

3.3.2

• Bugfix : where all field where validate and not the fields associated with the channel

3.3.1

• Added : super admin API key
• Removed : the entry_api_parent_rel extension as a seperated extension

3.3

• Added : Zoo Visitor support
• Added : $entry_id to the validate api function
• Added : fieldtype api method entry_api_post_delete, this will called after the entry is deleted
• Changed : the fieldtype api method entry_api_delete is now called before the entry is delete
• Bugfix : where the fieldtype api got not the correct value for $is_new
• Bugfix : where in some cases the url for the soap service cannot be found

3.2.1

• Added : entry_api_create_entry_start hook
• Added : entry_api_read_entry_start hook
• Added : entry_api_update_entry_start hook
• Added : entry_api_delete_entry_start hook
• Added : entry_api_search_entry_start hook

3.2

• Bugfix : where the install script was not working in MySQL strict
• Bugfix : where the site_id was missing in the testing_tool
• Bugfix : where the extra post data give an error on the rest services in the testing_tool
• Bugfix : Where the session was not correctly destroyed
• Bugfix : where in some case the return message was malformed due the license error
• Bugfix : where the url_trigger was not working in the testing tool
• Bugfix : where in some case mysql throws an error by giving the wrong API Key
• Updated : entry_api_read_entry_end hook to modify the actual entry_data array
• Added : entry_api_search_entry_per_entry that will called by getting the entry from the search
• Added : get Relationship/Playa parent extension (ext.entry_api_parent_rel)

3.1

• Bugfix : where there whas an undefined variable error for validate_errors in the create_entry method
• Added : url trigger
• Added : license check

3.0

• Bugfix : where there whas a php error by fetching the members in the CP
• Bugfix : seaching on only a channel name throws an error
• Bugfix : global debug setting works now
• Bugfix : lot of small issues
• Bugfix : where sometimes the channel_id was not set by an insert
• Added : Api Keys for easy access
• Added : support for categories in the entry CRUD methods category => '1|2|3'
• Added : new testing tool in the CP
• Added : IP Blacklist
• Added : free access Method on member level and global level for the read_entry() & search_entry()
• Added : new logging table
• Added : brand new Fieldtype API for other fieldtypes to adopt Entry Api
• Added : File compatible in the read methods
• Added : Membergroup assignment for the usage of the API
• Added : Relationship support
• Added : Playa support
• Added : basic Matrix support (not supporting special fieldtype with database tables, for now)
• Added : basic Grid support (not supporting special fieldtype with database tables, for now)
• Added : site_id var in the create method, this is now an require field. (almost MSM compatible now :-))
• Added : Auth API
• Changed : only one member can be choosen
• Changed : Credentials must be include in an array
• Updated : simplify the rest service
• Updated : Better File read, it will return an array with options of the file
• Updated : text fields are now validate on their length as well
• Updated : better CP UI
• Updated : codebase to be compatible with EE 2.7+
• Updated : min require EE version < 2.6
• Removed : the unit tester due its inefficiency
• Removed : Omnilog support

2.2.1

• Bugfix : PHP error in all category_group methods

2.2

• Added: Entry hooks: entry_api_create_entry_end, entry_api_update_entry_end, entry_api_delete_entry_end, entry_api_search_entry_end
• Added: Category Group hooks: entry_api_create_category_group_end, entry_api_read_category_group_end, entry_api_update_category_group_end, entry_api_delete_category_group_end
• Added Category hooks: entry_api_create_category_end, entry_api_read_category_end, entry_api_update_category_end, entry_api_delete_category_end
• Added: Status Check page
• Bugfix: small bugfixes in the unit tester
• Bugfix: small bugfixes in the services.
• Bugfix: where the Control Panel give an error with the message : Undefined index: no_inlog_channel
• Updated : Better PHP check on install in case the PHP version is below 5.3

2.1

• Added: search method for the Entry API in the XML-RPC/SOAP/REST services
• Added: category group API
• Added: Unit Tester for debugging and test all services and methods (domain.com/entry_api/test/?username=test&password=Test123&channel=news&membergroup=6)
• Modify: the return values of the XMLRPC READ method are changed. The values are located in the [data]array([0]) to confirm with the search method
• Modify: the return values of the SOAP READ method are changed. The values are located in the [data]array([0]) to confirm with the search method
• Modify: the return values of the REST READ method are changed. The values are located in the [data]array([0]) to confirm with the search method
• Modify: the log saves now only the username in the extend data and not the full request.
• Updated: the Slim rest server to V2.0.0
• Updated: min specs to PHP 5.3
• Bugfix: the rest services was setting SOAP request to the log
• Bugfix: database prefix was missing in the queries
• Bugfix: where the code suggest some wrong methods
• Bugfix: where the category API methods delete() and update() gives an PHP error
• Disabled: Temporary disable the services debug setting because this setting is not yet implemented.
• Optimized: The services are optimized for better performance

2.0.1

• Added: Al create function of the services return an ID of the created entry/category.

2.0

• Rewrite: the control panel so the services is build uppon a member and not a channel
• Rewrite: the services for better customization
• Update: the return codes
• Added: category CRUD API

1.2.1

• Bugfix: Where the authentication goes wrong.

1.2

• Added: REST support.
• Added: Debug field for enable debugging.
• Updated: A fresh new documentation for the services file is added.
• Changed: The method names are changed for more CRUD purpose.
• Changed: Response codes are more HTTP friendly.
• Bugfix: lot of minor bugs fixes.

1.1.2

• Bug fix: Where to log wasn`t working in some cases.

1.1.1

• Changed: The url is now changed to work without the ACT uri.
• Bugfix: Error message was always showing when the image field is empty.
• Bugfix: Delete channel wasn`t working.

1.1

• Added: Upload files through the services.
• Bugfix: The type data of a custom field was wrong.
• Bugfix: The service give a PHP error when not selecting a channel.

1.0

• Init release.