Recommended releases

Download Released

A standardized solution for building API's so that external clients can
communicate with Backdrop.

Goals

  • Create a unified Backdrop API for web services to be exposed in a variety of
    different server formats.
  • Provide a service browser to be able to test methods.
  • Allow distribution of API keys for developer access.

Documentation

http://drupal.org/node/109782

Installation

If you are using the rest server, you will need to download the latest version
of SPYC:

wget https://raw.githubusercontent.com/mustangostang/spyc/0.6.3/Spyc.php -O  servers/rest_server/lib/spyc.php

Once downloaded, you need to add spyc.php to the rest_server/lib folder, which
exists under the location you have installed the Services module in.

Documentation files

You can find these files in /docs folder:

  • services.authentication.api.php: hooks related to authentication plugins
  • services.servers.api.php: servers definition hooks
  • services.services.api.php: definition of new services
  • services.versions.api.php: how to write versioned resources

Settings via variables

'services_{$resource}_index_page_size' -- this variable controls maximum
number of results that will be displayed by the index query. See
services_resource_build_index_query() for more information.

How To Install

  1. Install according to usual Backdrop installation instructions.
  2. Enable in admin/modules.
  3. See http://drupal.org/node/109782 for further instructions.

License

This project is GPL v2 software. See the LICENSE.txt file in this directory for
complete text.

Maintainers

Credits

Drupal version currently maintained by: