Easy Blog Networks API Introduction
===================================

Conventions
-----------

#. The API is based on `Representational State Transfer
   <https://en.wikipedia.org/wiki/Representational_state_transfer>`_ (REST)
   software architecture concept and as such makes heavy use of `HTTP methods
   <https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods>`_.

#. The API always returns results in the
   `JSON <https://en.wikipedia.org/wiki/JSON>`_ format. All POST, PUT and PATCH
   requests should send their payloads in JSON as well.

#. All API paths end with a trailing slash.

#. Authentication is required for all API services, except for the ``ping``
   service. To authenticate, provide your `email` and your `API Key` as HTTP
   Basic Auth headers. Examples for each service are provided below. You
   can get your API Key on the `Account Settings
   <https://app.easyblognetworks.com/settings>`_ page.


The Ping service
----------------

Before your start connection to other EBN API services, it is helpful to test
your connection against our ``ping`` service. First do a `GET` request to
test you can reach our API, then do a `POST` request with your API credentials
included to test that you can successfully authenticate to the EBN API.

.. cornice-autodoc::
  :modules: pyramid_bimt.api
  :service: ping
  :ignore-methods: DELETE
  :docstring-replace: {
      "BIMT": "Easy Blog Networks",
      "http://localhost:8080": "https://app.easyblognetworks.com"
    }


----

Services
========


.. cornice-autodoc::
  :modules: ebn.api
  :service: collection_blog
  :docstring-replace: {
      "BIMT": "Easy Blog Networks",
      "http://localhost:8080": "https://app.easyblognetworks.com"
    }

See also:

* List of :ref:`wp-themes`.
* List of :ref:`wp-plugins`.

.. cornice-autodoc::
  :modules: ebn.api
  :services: collection_cornice_blog, cornice_blog
  :docstring-replace: {
      "BIMT": "Easy Blog Networks",
      "http://localhost:8080": "https://app.easyblognetworks.com"
    }
  :title-replace: {"Cornice_": "", "Collection_": ""}

.. cornice-autodoc::
  :modules: ebn.api
  :services: collection_cornice_blognetwork, cornice_blognetwork
  :docstring-replace: {
      "BIMT": "Easy Blog Networks",
      "http://localhost:8080": "https://app.easyblognetworks.com"
    }
  :title-replace: {"Cornice_": "", "Collection_": ""}

.. cornice-autodoc::
  :modules: ebn.api
  :services: cornice_import_wxr
  :docstring-replace: {
      "BIMT": "Easy Blog Networks",
      "http://localhost:8080": "https://app.easyblognetworks.com"
    }
  :title-replace: {"Cornice_": "", "Collection_": ""}