Developers
Início | Developers | API | Utilização
Plugins Moloni
Tradução automática
Pesquise na Documentação
Siga-nos nas redes sociais
Utilização
Alguns conceitos essenciais que deve ter em conta na utilização da API

Para trabalhar com a API, é fundamental estar familiarizado com pedidos POST e autenticação Oauth2.

Todos os pedidos para API deverão ser enviados através do método POST e os dados podem ser enviados em formato x-www-urlencoded ou em Json.

 

Na query string do pedido devem estar incluídos os seguintes parâmetros:

Access token (access_token)

Parâmetro obrigatório que deve estar sempre em todos os pedidos.

Json (json)

A API por defeito aceita apenas dados em formato x-www-urlencoded.
Para enviar os dados em formato Json deverá acrescentar na query string do pedido o parâmetro "json=true"

Human errors (human_errors)

Existe ainda outro parâmetro opcional: Human errors.
Ao enviar este parâmetro, quando a API devolver algum erro, como por exemplo, inserir um documento ou inserir um artigo, juntamente com o erro, vem uma mensagem verbosa do mesmo.

Por exemplo, na falta da indicação de uma série de documento é retornado o erro "2 document_set_id".

Body

Os restantes dados são enviados no body do POST, podendo estes ser enviados, tal como referido acima, em formato x-www-urlencoded ou Json.

Por exemplo, "company_id=5" em x-www-urlencoded ou "{company_id:5}" em json

© 2019 Moloni. Termos de Utilização