A Api de Integração
===========================================
A api de integração disponibiliza serviços através de webservices, para a busca, 
a criação, edição e deleção de registros do cake.

Habilitando a integração de um serviço
--------------------------------------
Para habilitar a integração de um serviço primeiro ela deve ser cadastrada no 
cake e no momento do cadastro será gerado um token de acesso a api. Este token
deverá ser passado sempre no cabeçalho da request com a chave "**X-cake-token**".

Todos os serviços possuem uma url base de acessso que pode ser encontrada em 
:doc:`Serviços <servicos>`. 
Todas as requests devem utilizar content-type **application/json**

Erros de Retorno
-----------------

    :Acesso Negado: {'status':403, 'message':'Acesso Negado'}
    :Operações: {'error': 'mensagem do erro'}

Buscando uma lista de registros
--------------------------------
Para acessar a listagem de registro de um serviço deve ser utilizada a url base
acrescida de /all com o método **GET**

Para realizar filtros os parametros devem ser passados na url, os parametros de 
filtro diponibilizadas são:

* **Igual**
    Ex. /url_base/all?atributo=valor

* **Diferente**
    Ex. /url_base/all?atributo!valor

* **Maior**
    Ex. /url_base/all?atributo__> =valor

* **Menor**
    Ex. /url_base/all?atributo__< =valor

* **In**
    Ex. /url_base/all?atributo__in = valor1, valor2, valor3

* **Notin**
    Ex. /url_base/all?atributo__not_in = valor1, valor2, valor3

Parâmetros de controle:

* **Offset**
    Ex. /url_base/all?offset=10

* **Limit**
    Ex. /url_base/all?limit=40

* **Not null**
    Ex. /url_base/all?atributo=not null

* **Null**
    Ex. /url_base/all?atributo= null

* **Order_by**
    Ex. /url_base/all?order by =atributo1 asc, atributo2 desc

   :retorno: json lista de objetos

Buscando um registro específico
-------------------------------
Para buscar um registro específico deve utilizar /url_base/all?id=valor com o método **GET**

   :parametro id: id do registro
   :retorno: {'registry':json do objeto}

Criando/Editando um registro específico
---------------------------------------
Para buscar um registro específico deve utilizar /url_base/ com o método 
**POST** e passar os atributos com seus valores, se existir o atributo com valor
será executado um update, caso contrário será executado um insert.

   :parametro id: id do registro
   :retorno: {'registry':json do objeto adicionado/alterado}

Deletando um registro
----------------------
Para buscar um registro específico deve utilizar /url_base/ com o método 
**DELETE** e passar por parametro o atributo id com seu valor.

   :parametro id: id do registro
   :retorno: {'registry':json do objeto apagado}

Indices and tables
------------------
* :doc:`Api <api>`
* :doc:`Serviços <servicos>`
* :ref:`search`