Migrar da Versão 1
—-
Impacto: leve
V1 Utilizado o parâmetroapi_token
.
V2 A autenticação é feita através de um Bearer Token. -
Impacto: leve
V1 A chave API gerada está sempre disponível para consulta.
V2 A chave API gerada só pode ser visualizada uma vez.
-
Impacto: crítico
V1 Sempre devolvido a estrutura de resposta{ status: true, data: ...}
.
V2 Não existe estrutura de resposta, sendo imediatamente devolvido o resultado. -
Impacto: moderado
V1 Considerado o parâmetro da respostastatus
para determinar se o pedido foi bem ou mal sucedido.
V2 O status code determina se o pedido foi bem ou mal sucedido.
-
Impacto: crítico
V1 Todos os pedidos utilizam o métodoPOST
.
V2 Os pedidos devem ser feitos utilizando os métodosPOST
,PUT
,DELETE
. -
Impacto: moderado
V1 O URL dos pedidos possuem a seguinte nomenclaturacustomers/:id/update
.
V2 O URL dos pedidos possuem a seguinte nomenclaturaPUT customers/:id
.
- O parâmetro
callback_url
foi adicionado nas vendas.
- Impacto: leve O parâmetro
contact
na ficha de cliente passa aother_contacts
.
-
Impacto: leve O parâmetro
to
, no pedido de envio de uma SMSsales/:id/send_sms
(e recibos), passa a receber apenas um recipiente.
- Impacto: leve O parâmetro
assign_to_all
no endpoint das Séries. - Impacto: leve O parâmetro
assign_as_default
no endpoint das Séries. - Impacto: leve O parâmetro
communicate
no endpoint das Séries. - Impacto: leve O parâmetro
communicate_documents_types
no endpoint das Séries.
- Impacto: leve O endpoint
administration/documentstypes/*
. - Impacto: leve O endpoint
administration/series/by_document_type
. - Impacto: leve O endpoint
items/:id/stock/actual
. - Impacto: leve O endpoint
items/stock/movements/*
. - Impacto: leve O endpoint
customers/:id/accounts_open/*
. - Impacto: leve O endpoint
customers/accounts_open
. - Impacto: leve O endpoint
bookings/*
. - Impacto: leve O endpoint
administration/all
. - Impacto: leve O endpoint
subscription/*
.
- Impacto: leve O endpoint
subscription/locations/create
foi alterado paraPOST administration/locations
. - Impacto: leve O endpoint
subscription/locations/:id/update
foi alterado paraPUT administration/locations/:id
. - Impacto: leve O endpoint
subscription/locations/:id/delete
foi alterado paraDELETE administration/locations/:id
. - Impacto: leve O endpoint
subscription/locations/find
foi alterado paraPOST administration/locations/find
.
-
Impacto: moderado O campo
status
nas vendas passa a receber três estadosRascunho
,Terminado
eCancelado
, anteriormente apenas recebiaRascunho
eTerminado
. -
Impacto: moderado O campo
status
nos recibos passa a receber três estadosRascunho
,Terminado
eCancelado
, anteriormente apenas recebiaRascunho
eTerminado
.
Impacto: crítico
Todos os endpoints "/find" passam a devolver como resposta apenas um resultado ao invês de um array de resultados, exemplo:
V1 { status: true, data: [{customer}, {customer}] }
.
V2 { customer }
.
Impacto: crítico
Todos os endpoints "/list" foram eliminados. O objectivo da API do Facturalusa é proporcionar uma integração eficiente na criação de
documentos e tabelas secundárias e não de disponibilizar funcionalidades de navegação externas ao Facturalusa como, por exemplo, a navegação
na lista de clientes e artigos.
A gestão local de toda a informação criada no Facturalusa, incluindo artigos e clientes, é da responsabilidade de quem integra com a API. Por exemplo, quando cria um cliente, deve guardar na sua base de dados o ID devolvido pelo Facturalusa, para que o possa utilizar posteriormente na emissão de uma Factura.
Esta alteração tem como objectivo optimizar a utilização da API, tornando os processos de criação e gestão de documentos mais ágeis e seguros, evitando que a API seja usada de forma excessiva para outros fins.