API do Libax Business

Aqui poderá encontrar toda a documentação relacionada com a API do Libax Business para o ajudar a ligar a sua aplicação com o seu software de faturação. Com esta integração poderá facilmente:

• Criar clientes
• Emitir faturas ou outro tipo de documentos
• Realizar impressão de documentos
• e muito mais...

É uma excelente solução para adicionar as funcionalidade de faturação à sua loja on-line ou a outra aplicação que necessite de ter um suporte de faturação associado.

Obter o ClientID

Para utilizar a API é preciso criar um clientID para utilizar na fase de autenticação.

Esta funcionalidade está disponível Business -> Configurações (roda dentada em cima à direita) -> Cliente API

Após entrar nesta opção, pressione o botão Criar conforme imagem seguinte:

Após criação do ID de cliente, será mostrado o ID e o seacret conforme imagem seguinte:

O secret não será mostrado novamente. Assim, guarde esta informação num local seguro e partilhe apenas com que vai utilizar a API. Caso perca informação terá de gerar novo secret.

A qualquer momento poderá voltar a esta configuração se pretender remover esta funcionalidade.

Utilizar a API

A API está disponível no endereço https://api.libax.com/business/v1/

Neste endereço está também disponível a documentação Swagger onde pode também autenticar-se e invocar os métodos de forma a facilitar o desenvolvimento.

Para a autenticação ser completa é necessário escolher o scope business_public_api conforme imagem seguinte:

Limites de utilização

A API está protegida com um número de requests por minuto:

• 100 requests por minuto todos os dias entre as 9h e as 19h (hora de Portugal continental)
• 200 requests por minuto todos os dias entre as 19h e as 9h (hora de Portugal continental)

Em todos os responses, irá obter os seguintes headers:

• X-Rate-Limit - indica quantos requests já fez desde que o contador voltou a zero
• X-Rate-Limit-Remaining - indica quantos requests ainda pode fazer dentro do minuto a decorrer

Dica: Utilize estes headers para não exceder o número de requests permitidos por minuto.

Se exceder o limite de requests por minuto, irá obter um erro 429 com o header Retry-After que indica o tempo no formato delta-seconds que tem de esperar para que possa fazer um novo request.

Dúvidas e apoio ao desenvolvimento

Se durante o desenvolvimento surgirem dúvidas ou pretende ajudar no desenvolvimento, não hesite em contactar-nos pelo e-mail support@libax.com