Visão geral da API v4
A MuCRM tem API HTTP integrada. Qualquer cliente que fale HTTP pode consumir: site, app mobile, painel, bot, launcher ou scripts de integração.
Não é "API só para launcher". É REST/JSON para ler, criar, atualizar e apagar recursos — posts, pedidos, tickets, contas, o que seu produto precisar.
💡Site e painel ficam em outro menu
Rotas com sessão, views
.mucrm.php e formulários CSRF estão no guia Começar. Aqui o contrato é JSON.O que você pode fazer
| Operação | Exemplo |
|---|---|
| Ler | listar posts, usuários, perfil, configurações |
| Criar | abrir ticket, publicar notícia, registrar pedido |
| Atualizar | editar perfil, mudar status, debitar saldo |
| Autenticar | login com Bearer, token de serviço, OAuth |
| Integrar | Discord, pagamentos, apps desktop, mobile |
O JSON de saída fica no HTTP Data — o Model não vaza para o client.
Em 30 segundos
- Cliente chama
POST /api/logincom usuário e senha - API devolve um token (
mcrm_…) - Nas próximas requests:
Authorization: Bearer mcrm_… - Ou um token de serviço que você mesmo definiu (app, cron, integração)
Authorization: Bearer SEU_TOKEN
Accept: application/json
Content-Type: application/jsonDois jeitos de autenticar
| Jeito | Quando usar | Como ler no PHP |
|---|---|---|
| Token de login | Usuário / conta logada | Middleware auth:api + request()->user() |
| Token de serviço | App, bot, cron, integração sem login de pessoa | Você define $myToken e compara com request()->bearer_token() |
Detalhes: Login e Bearer Token.
Rotas prontas do Core
| Método | Rota | Auth | O que faz |
|---|---|---|---|
POST | /api/login | — | Gera token de login |
POST | /api/me | Bearer | Dados do usuário autenticado |
POST | /api/logout | Bearer | Revoga o token de login |
O restante (/api/posts, /api/users, /api/settings/...) você declara no mesmo grupo:
uri::group(['prefix' => 'api', 'without_csrf' => true], function () {
uri::post('/login', [auth_handler::class, 'login']);
uri::group(['middleware' => ['auth:api']], function () {
uri::get('/me', [profile_handler::class, 'me']);
uri::post('/logout', [auth_handler::class, 'logout']);
});
});Por onde começar
- HTTP Data — contrato JSON (o que o client recebe)
- Login e Bearer Token — login e token de serviço
- Respostas JSON e erros —
json()e HTTP 422
Os guias em C#, Node e JavaScript são exemplos de client. A API em si é só HTTP — PHP, Python, Go, Dart, o que for.
ℹ️Web continua igual
Sessões
user / admin do site não mudaram. A API é um caminho paralelo, não um substituto.