Hierarquia
Organização
Organização
A raiz de cobrança e de propriedade. Reúne os membros da equipe, o plano e os projetos. Pessoas entram em uma organização com um papel (proprietário, administrador, cobrança, desenvolvedor ou visualizador).
Projeto
Projeto
A fronteira de isolamento. Todo recurso e toda chave de API pertencem a exatamente um projeto, e não existe leitura entre projetos. Um projeto tem um ambiente,
live ou test (veja Ambientes).Canal
Canal
Um endereço de comunicação configurado dentro de um projeto, por exemplo um número de WhatsApp. Não confunda com o tipo de canal: hoje o único tipo é
whatsapp. O canal é identificado por chan_... e é o campo channel das chamadas de envio.Canais
Um canal só envia mensagens quando estáactive.
Enviar por um canal que não está
active retorna 422 com o código channel_inactive. Mudanças de estado geram o evento channel.status_changed.
A conexão e o gerenciamento de canais são feitos no painel. As credenciais do provedor nunca são retornadas pela API.
Identificadores
Todo recurso tem um identificador com prefixo, seguido de um ULID de 26 caracteres. Os ULIDs são ordenáveis no tempo, seguros para URLs e fáceis de reconhecer em logs.Trate os identificadores como strings opacas. Não faça parse nem presuma o comprimento, apenas o prefixo.
Isolamento entre projetos
A API autentica cada chave em exatamente um projeto, e toda consulta é filtrada por ele. Um recurso de outro projeto responde404, nunca 403, para que a existência dele não vaze.
Compatibilidade com campos novos
Dentro da versãov1, a Routa só faz mudanças aditivas: novos endpoints, novos campos opcionais e novos campos de resposta. Ignore campos desconhecidos nas respostas, e ignore tipos de evento que você não reconhece. Veja Versionamento.