Introdução

O Yuv Cloud Services foi desenvolvido para facilitar a homologação de rastreadores, câmeras e dispositivos IoT.

Com nossa API e Data Push, você consegue consumir os dados dos equipamentos sem a necessidade de desenvolver gateways ou servidores RTMP.

Nossos serviços permitem:

Receber dados em tempo real

Consumir streaming

Receber imagens e vídeos de alarmes

Enviar comandos

Tudo isso, de forma simples e integrada, através da API e Data Push.

Funcionamento

Uma vez que os equipamentos são configurados para se comunicarem com os servidores da YUV, todo o processo de homologação acontece dentro da nossa infraestrutura.

Os dados ficam disponíveis tanto na plataforma da YUV quanto via API, permitindo que você escolha entre usar nossa plataforma ou a sua própria.

Sempre que recebemos informações de GPS, alarmes ou qualquer outro dado homologado, enviamos diretamente para o seu Webhook configurado.

URL Base

Todos os endpoints devem ser acessados a partir da seguinte URL base:
https://api.cloud-services.yuv.com.br

Autenticação

Todos os endpoints são protegidos por um Bearer Token. É necessário enviar esse token no header de todas as requisições.

Para obter um token de acesso, entre em contato com seu gestor comercial.

Data Push (Webhook)

O Data Push é o serviço responsável por entregar os dados em tempo real no seu Webhook, sem a necessidade de ficar consultando a API constantemente.

Toda requisição enviada ao seu Webhook deve obrigatoriamente responder com HTTP 200 em até 3 segundos.

Caso não haja resposta válida, novas tentativas serão feitas a cada 10 minutos, por até 3 dias.

Após esse período, os dados serão descartados permanentemente.

Todas as requisições enviadas possuem content-type: application/json

Para configurar a URL base do seu Webhook, entre em contato com o seu gestor comercial.

Limites de Requisição (Rate Limit)

Para garantir a estabilidade do ecossistema e a alta disponibilidade de nossos serviços, aplicamos limites de taxa de processamento (Rate Limiting) baseados na categoria do endpoint solicitado.

Categoria de Endpoint	Descrição	Limite
Escrita & Controle	Configuração de equipamentos e envio de comandos	80 req/s
Leitura & Consulta	Listagem de dados, status e relatórios	100 req/s

Nem todos os recursos da nossa API estão sujeitos aos limites mencionados acima. Alguns endpoints específicos, devido à sua natureza crítica ou de baixo custo computacional, não possuem restrição de Rate Limit.

Endpoint Limitado: Apresentará o status 429 Too Many Requests em sua lista de respostas possíveis.

Endpoint de Livre Demanda: Não listará o status 429 em sua documentação de referência.

Comportamento da API

Quando o limite de requisições for excedido, a API retornará o erro HTTP 429 Too Many Requests.

Boas Práticas

Implemente Backoff Exponencial: Caso receba um erro 429, aguarde um tempo crescente antes de tentar novamente em vez de repetir a chamada imediatamente.

Funcionamento#

URL Base#

Autenticação#

Data Push (Webhook)#

Limites de Requisição (Rate Limit)#

Comportamento da API#