1. Clientes
Yuv Cloud Services
prod
  • prod
  • quality
  • Introdução
  • Referências
  • Data Push
    • /pushFileDownloadRequest
    • /occurrence
    • JC181
      • /jc181/pushHeartbeat
      • /jc181/pushGps
      • /jc181/pushAlarm
      • /jc181/pushAlarmFile
      • /jc181/pushFileList
    • JC182
      • /jc182/pushGps
      • /jc182/pushHeartbeat
      • /jc182/pushFileList
      • /jc182/pushAlarm
      • /jc182/pushAlarmFile
    • JC371
      • /jc371/pushGps
      • /jc371/pushHeartbeat
      • /jc371/pushAlarm
      • /jc371/pushAlarmFile
      • /jc371/pushFileList
    • JC400
      • /jc400/pushHeartbeat
      • /jc400/pushGps
      • /jc400/pushAlarm
      • /jc400/pushAlarmFile
      • /jc400/pushFileList
    • JC450
      • /jc450/pushHeartbeat
      • /jc450/pushGps
      • /jc450/pushAlarm
      • /jc450/pushAlarmFile
      • /jc450/pushFileList
  • API (Revendedor)
    • Alarmes
      • Obter Alarmes
    • Ativos
      • Obter lista
      • Visualizar
      • Cadastrar
      • Editar
      • Vincular/Desvincular equipamento
      • Deletar
    • Equipamentos
      • Obter lista para seleção
      • Obter lista
      • Abrir streaming
      • Visualizar
      • Cadastrar
      • Editar
      • Deletar
      • Enviar comando
    • Clientes
      • Obter lista
        GET
      • Editar
        PUT
      • Obter token
        GET
      • Cadastrar token
        POST
      • Cadastrar
        POST
      • Deletar
        DELETE
      • Deletar token
        DELETE
    • Downloads
      • Requisitar lista de arquivos
      • Requisitar arquivo
    • Playback
      • Streaming
    • Motoristas
      • Obter lista
      • Cadastrar
    • Ocorrências
      • Obter lista
      • Tratativa
    • Grupo de Permissão
      • Obter lista
    • GPS
      • Obter GPS
      • Obter Deslocamento
    • Manutenções
      • Obter lista
    • Abastecimentos
      • Obter lista
  • API (Cliente)
    • Controle de Acesso
    • Alarmes
      • Obter Alarmes
    • Equipamentos
      • Obter lista
      • Abrir streaming
    • Motoristas
      • Obter lista
      • Cadastrar
    • Ocorrências
      • Tratativa
      • Obter lista
    • GPS
      • Obter GPS
      • Obter Deslocamento
    • Manutenções
      • Obter lista
    • Abastecimentos
      • Obter lista
  1. Clientes

Cadastrar

POST
/customer
Cadastra um cliente junto com o seu usuário principal (root), que poderá acessar a plataforma e gerar tokens de Cliente.
Disponível para: Somente Revendedor
Rate limit: 100 requisições/minuto

Regras#

O cliente é sempre criado ativo.
O e-mail (userEmail) é o login do usuário principal.
Sem timeZoneId, é usado o fuso padrão (ID 13).
Idiomas e demais IDs de referência: https://app.apidog.com/project/922569/apis/doc-1335233
Na resposta, permissionGroup, occurrenceSetting, alarmSetting, language, timeZone e customerCnpj vêm null.
permissionGroupId precisa ser um grupo do tipo Cliente. userEmail é único (422).

Erros específicos#

languageId inexistente → 400 com {"error": "language_id inválido: <id>"}.

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢200Sucesso
application/json
Bodyapplication/json

🟠400Bad request
🟠403Forbidden
🟠422Unprocessable Entity
🟠429Too Many Request
🔴500Internal server error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.cloud-services.yuv.com.br/customer' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerName": "Transportadora Exemplo",
    "userName": "Maria Souza",
    "userEmail": "maria@exemplo.com.br",
    "userPassword": "senha123",
    "permissionGroupId": 1,
    "languageId": 1,
    "timeZoneId": 13,
    "customerZipCode": "01310-100",
    "customerAddress": "Av. Paulista, 1000",
    "customerCity": "São Paulo",
    "customerPhone": "(11) 99999-0000",
    "streamingLimit": 5
}'
Response Response Example
200 - Sucesso
{
    "data": {
        "customerId": 45,
        "customerName": "Transportadora Exemplo",
        "customerEmail": "maria@exemplo.com.br",
        "customerIsEnabled": true,
        "permissionGroup": null,
        "occurrenceSetting": null,
        "customerCnpj": null,
        "customerZipCode": "01310-100",
        "customerAddress": "Av. Paulista, 1000",
        "customerComplement": null,
        "customerNeighborhood": null,
        "customerCity": "São Paulo",
        "customerState": null,
        "customerPhone": "(11) 99999-0000",
        "customerObservation": null,
        "customerStreamingLimit": 5,
        "occurrenceSettingId": null,
        "alarmSettingId": null,
        "alarmSetting": null,
        "customerCreatedAt": "2025-05-20T12:00:00Z",
        "customerUpdatedAt": "2025-05-20T12:00:00Z",
        "userId": 120,
        "userName": "Maria Souza",
        "userIsEnabled": true,
        "userTypeId": 4,
        "permissionGroupId": 1,
        "languageId": 1,
        "language": null,
        "timeZoneId": 13,
        "timeZone": null
    }
}
Modificado em 2026-10-15 18:09:16
Página anterior
Cadastrar token
Próxima página
Deletar
Built with