Pular para o conteúdo

API do SmartOSH

SmartOSH dispõe de uma API REST que permite a desenvolvedores e integradores aceder aos dados e funcionalidades da plataforma de forma programática, facilitando a integração com sistemas externos (ERPs, ferramentas de RH, portais corporativos, etc.).

A documentação completa da API, incluindo todos os endpoints disponíveis, parâmetros, esquemas de dados e a possibilidade de realizar testes em tempo real, está disponível no Swagger UI:

Abrir documentação da API (Swagger)

Para interagir com a API é necessário dispor de credenciais de acesso. Contacte a equipa da SmartOSH para obter as chaves de API correspondentes à sua conta.

O uso da API está sujeito à política de “fair use” da SmartOSH, que define os limites técnicos de velocidade, as boas práticas de integração e os critérios de intervenção em casos de uso abusivo.

Ver política de “fair use” da API e cargas massivas de dados

Se tiver dúvidas sobre a integração ou precisar de ajuda com algum endpoint, contacte a equipa técnica da SmartOSH através dos canais habituais de suporte.