Central de ajuda

Referência da API

🏢 Tenant API

POST /tenantCreateApi

CreateApi

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏢 Tenant API"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, sem protocolo e sem barra final."}}}],"security":[{"superAdminAuth":[]}],"components":{"securitySchemes":{"superAdminAuth":{"type":"http","scheme":"bearer","description":"Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: `SuperAdminToken`)."}}},"paths":{"/tenantCreateApi":{"post":{"tags":["🏢 Tenant API"],"summary":"CreateApi","operationId":"CreateApi","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome da API que será criada"},"sessionId":{"type":"integer","description":"ID da sessão do WhatsApp associada"},"urlServiceStatus":{"type":"string","description":"URL para receber atualizações de status do serviço (opcional)","nullable":true},"urlMessageStatus":{"type":"string","description":"URL para receber atualizações de status das mensagens (opcional)","nullable":true},"userId":{"type":"integer","description":"ID do usuário que está criando a API"},"authToken":{"type":"string","description":"Token de autenticação para a API"},"tenant":{"type":"integer","description":"ID do tenant que terá a API"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

CreateSessionTenant

Endpoint com mais de um formato de payload na coleção oficial: **CreateSessionTenant**, **CreateSessionTenant (Híbrido)**. Veja os exemplos do corpo para escolher a variante.

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏢 Tenant API"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, sem protocolo e sem barra final."}}}],"security":[{"superAdminAuth":[]}],"components":{"securitySchemes":{"superAdminAuth":{"type":"http","scheme":"bearer","description":"Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: `SuperAdminToken`)."}}},"paths":{"/tenantApiCreateSession":{"post":{"tags":["🏢 Tenant API"],"summary":"CreateSessionTenant","operationId":"CreateSessionTenant","description":"Endpoint com mais de um formato de payload na coleção oficial: **CreateSessionTenant**, **CreateSessionTenant (Híbrido)**. Veja os exemplos do corpo para escolher a variante.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tenant":{"type":"integer","description":"Tenant"},"name":{"type":"string","description":"Nome da instância do WhatsApp"},"status":{"type":"string","description":"Status inicial da sessão (DISCONNECTED, CONNECTED)"},"type":{"type":"string","description":"Tipo da sessão (whatsapp, baileys, zapo, meow, evo, uazapi, zapi)"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

POST /tenantDeleteApi

DeleteApi

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏢 Tenant API"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, sem protocolo e sem barra final."}}}],"security":[{"superAdminAuth":[]}],"components":{"securitySchemes":{"superAdminAuth":{"type":"http","scheme":"bearer","description":"Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: `SuperAdminToken`)."}}},"paths":{"/tenantDeleteApi":{"post":{"tags":["🏢 Tenant API"],"summary":"DeleteApi","operationId":"DeleteApi","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"integer","description":"ID da sessão do WhatsApp associada à API"},"userId":{"type":"integer","description":"ID do usuário que está deletando a API"},"tenant":{"type":"integer","description":"ID do tenant que possui a API"},"apiId":{"type":"string","description":"ID da API que será deletada"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

GET /tenantApiListTenants

ListTenants

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏢 Tenant API"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, sem protocolo e sem barra final."}}}],"security":[{"superAdminAuth":[]}],"components":{"securitySchemes":{"superAdminAuth":{"type":"http","scheme":"bearer","description":"Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: `SuperAdminToken`)."}}},"paths":{"/tenantApiListTenants":{"get":{"tags":["🏢 Tenant API"],"summary":"ListTenants","operationId":"ListTenants","responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

POST /tenantApiShowTenant

ShowTenant

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏢 Tenant API"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, sem protocolo e sem barra final."}}}],"security":[{"superAdminAuth":[]}],"components":{"securitySchemes":{"superAdminAuth":{"type":"http","scheme":"bearer","description":"Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: `SuperAdminToken`)."}}},"paths":{"/tenantApiShowTenant":{"post":{"tags":["🏢 Tenant API"],"summary":"ShowTenant","operationId":"ShowTenant","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"ID do tenant que será consultado"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

POST /tenantApiStoreTenant

StoreTenant

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏢 Tenant API"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, sem protocolo e sem barra final."}}}],"security":[{"superAdminAuth":[]}],"components":{"securitySchemes":{"superAdminAuth":{"type":"http","scheme":"bearer","description":"Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: `SuperAdminToken`)."}}},"paths":{"/tenantApiStoreTenant":{"post":{"tags":["🏢 Tenant API"],"summary":"StoreTenant","operationId":"StoreTenant","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status do tenant (active, inactive)"},"name":{"type":"string","description":"Nome da empresa/tenant"},"maxUsers":{"type":"integer","description":"Número máximo de usuários permitidos"},"maxConnections":{"type":"integer","description":"Número máximo de conexões WhatsApp permitidas"},"acceptTerms":{"type":"boolean","description":"Confirmação de aceite dos termos"},"email":{"type":"string","description":"Email do administrador do tenant"},"password":{"type":"string","description":"Senha do administrador (mínimo 8 caracteres, incluindo números e caracteres especiais)"},"userName":{"type":"string","description":"Nome completo do administrador"},"profile":{"type":"string","description":"Perfil do administrador (admin, user)"},"paymentGateway":{"type":"string","description":"Vinculo de gateway de pagamento (OPCIONAL). Define qual gateway o webhook usa para atualizar o status de pagamento do tenant automaticamente. Valores: asaas, stripe, pagarme, mercadopago."},"stripeCustomerId":{"type":"string","description":"Credenciais do gateway informado acima (envie apenas o par do gateway escolhido). Exemplo Stripe: Customer ID + Secret Key."},"stripeToken":{"type":"string"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

POST /tenantApiUpdateTenant

UpdateTenant

{"openapi":"3.0.3","info":{"title":"sistema — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🏢 Tenant API"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação sistema do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend sistema, sem protocolo e sem barra final."}}}],"security":[{"superAdminAuth":[]}],"components":{"securitySchemes":{"superAdminAuth":{"type":"http","scheme":"bearer","description":"Token de super admin, exigido pelas rotas de Tenant API (na coleção Postman: `SuperAdminToken`)."}}},"paths":{"/tenantApiUpdateTenant":{"post":{"tags":["🏢 Tenant API"],"summary":"UpdateTenant","operationId":"UpdateTenant","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"string","description":"Identidade do tenant (CPF/CNPJ) - identificador usado para reconhecer qual tenant será atualizado"},"status":{"type":"string","description":"Status do tenant (active, inactive)"},"maxUsers":{"type":"integer","description":"Número máximo de usuários permitidos"},"maxConnections":{"type":"integer","description":"Número máximo de conexões permitidas"},"paymentGateway":{"type":"string","description":"Gateway de pagamento (none, asaas, mercadopago, stripe, pagarme)"},"supportChatEnabled":{"type":"string","description":"Credenciais do gateway (OPCIONAL) — envie o par correspondente ao paymentGateway. Ao trocar para um gateway nao-Asaas, o modo Asaas legado e desligado automaticamente. Stripe:       \"stripeCustomerId\": \"cus_xxx\",      \"stripeToken\": \"sk_live_xxx\" Pagar.me:     \"pagarmeCustomerId\": \"cus_xxx\",     \"pagarmeToken\": \"sk_xxx\" Mercado Pago: \"mercadopagoCustomerId\": \"123456\",  \"mercadopagoToken\": \"APP_USR-xxx\" Chat de suporte habilitado (enabled, disabled)"},"menuVisibility":{"type":"array","description":"Menus visíveis — array de strings com os menus habilitados Opções: Groups, MassDispatch, Kanban, Tasks, Api, ChatBot, Reports, Campaigns, PrivateChat, Teams, AllowedChannels","items":{"type":"string"}},"allowedChannels":{"type":"array","description":"Canais permitidos — array de strings com os canais habilitados Opções: waba, baileys, zapo, whatsapp, meow, evo, zapi, uazapi, telegram, hub, webchat, webmail, wabaoauth, instagramoauth, facebookoauth","items":{"type":"string"}},"channelConnectionLimits":{"type":"object","description":"Limite máximo de conexões por tipo de canal. Use 0 para ilimitado.","properties":{"waba":{"type":"integer"},"baileys":{"type":"integer"},"zapo":{"type":"integer"},"whatsapp":{"type":"integer"},"meow":{"type":"integer"},"evo":{"type":"integer"},"zapi":{"type":"integer"},"uazapi":{"type":"integer"},"telegram":{"type":"integer"},"hub":{"type":"integer"},"webchat":{"type":"integer"},"webmail":{"type":"integer"},"wabaoauth":{"type":"integer"},"instagramoauth":{"type":"integer"},"facebookoauth":{"type":"integer"}}},"oauthEnabled":{"type":"boolean","description":"OAuth (Meta Embedded Signup) OAuth habilitado (true/false)"},"oauthProxyUrl":{"type":"string","description":"URL do Proxy OAuth"},"instagramWebhookProxyUrl":{"type":"string","description":"URL do Proxy de Webhook Instagram"},"instagramWebhookProxySecret":{"type":"string","description":"Segredo do Proxy Instagram"},"messengerWebhookProxyUrl":{"type":"string","description":"URL do Proxy de Webhook Messenger"},"messengerWebhookProxySecret":{"type":"string","description":"Segredo do Proxy Messenger"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}