MOST Docs
Consumindo a API
Autenticação
:::info
É obrigatório utilizar a rota de autenticação antes de qualquer requisição nas APIs, garantindo o acesso e o correto funcionamento dos serviços.
:::
A autenticação das nossas APIs utiliza o padrão
Já possui uma conta e deseja contratar um novo serviço ou solicitar uma client key de POC para testes? Entre em contato conosco pelo e-mail comercial@most.com.br.
Domínios
Os serviços de API da MOST devem ser consumidos pelo backend do cliente e seus servidores devem estar cadastrados em uma whitelist de IPs. Desta forma, quaisquer comunicações com os dispositivos embarcados deverão passar pelo backend do cliente antes de serem direcionados ao mostQI.
:::info
- Domínio de produção: production-mostqiapi.com (com whitelist)
- Domínio de produção, homologação e POC: mostqiapi.com (sem whitelist)
:::
O domínio de homologação e POC pode ser acessado a partir de qualquer IP. Estes dois domínios apontam para o mesmo ambiente de produção.
Não é recomendado usar o domínio mostqiapi.com para produção, uma vez que ele está sujeito a sofrer interrupções associadas a gatilhos de segurança.
:::caution
- O domínio exclusivo de produção só pode ser acessado por backends cujos IPs foram cadastrados em uma whitelist do mostQI.
- Todas as requisições deverão ser feitas usando o protocolo HTTPS.
:::
Testes na Plataforma DOCs
A documentação da nossa API é disponibilizada através de uma plataforma terceirizada para facilitar a visualização e interação com os endpoints fornecidos. É importante observar os seguintes pontos:
:::danger
Os testes realizados diretamente na plataforma de documentação devem ser efetuados apenas com o uso da client key de POC (Proof of Concept), que é destinada para fim de demonstração e possui o consumo limitado. O uso de client keys de produção deve ser realizado exclusivamente através da integração direta pelo backend dos clientes.
:::
Segurança da client key: É responsabilidade do cliente manter a client key em segurança e sigilo. Recomendamos implementar medidas adequadas para proteger a client key contra acessos não autorizados. O cliente será responsável pelos custos de todas as consultas feitas com sua client key.
Utilização Responsável: A utilização da API e suas clientkeys deve seguir os termos estabelecidos nos acordos de serviço e nas políticas de segurança da sua organização.
Para mais informações sobre o uso da nossa API, leia a documentação completa disponível na plataforma.