Convenções

camelCase 🐪

As respostas da API e retornos de websocket estão padronizados no formato camelCase.

Datas 🗓️

Todas as datas utilizadas nos objetos estão no padrão ISO 8601. Além disso, o fuso horário utilizado para essas datas segue o Tempo Universal Coordenado (UTC).

Nomenclaturas 📝

  • Cliente: Refere-se ao cliente back-end que consome a API do Move Chat. Normalmente utilizada para gerenciar seu domínio.
  • Cliente Web: Refere-se ao cliente web que consome a API do Move Chat e seu websocket. Normalmente utilizado pelo usuário final para interagir com o ambiente do chat.
  • Chat: Refere-se ao serviço de mensagens em tempo real.
  • Q&A: Refere-se ao serviço de perguntas e respostas.
  • DM: Refere-se ao serviço de mensagens diretas.

Códigos de erro

Alguns endpoints podem retornar um ou mais "ErrorCode" que em conjunto com o HttpStatusCode retornado pela API podem facilitar a tratativa e compreensão dos erros.