Integração e APIs
Conecte o OpsScript com suas ferramentas
Visão Geral
O OpsScript oferece diferentes formas de integração:
- Integrações nativas: notificações e automações no Slack e no Microsoft Teams. Veja a seção Integrações.
- Alertas (Webhooks de entrada): receba eventos de sistemas externos (ex.: Alertmanager) e abra chamados automaticamente. Veja Alertas.
- API REST: automatize ações usando um token pessoal.
- MCP server (Model Context Protocol): acesso às principais funcionalidades do sistema para clientes MCP (IDEs, assistentes com IA). Veja IA e Automação.
[Assista o vídeo de Integrações e APIs]
Alertas (Webhooks de entrada)
Os webhooks do OpsScript são de entrada: um sistema externo envia uma requisição HTTP para uma URL gerada pela plataforma e o OpsScript abre um chamado a partir dos dados recebidos. Esse é o caminho usado para converter alertas de monitoramento em chamados.
A configuração é feita em Integrações → Alertas. Consulte o guia completo em Alertas.
API REST
Autenticação
A API é autenticada por token de acesso pessoal (formato ops_pat_...) com escopos granulares: cada token vale para uma organização e apenas para as permissões que você conceder. Para gerar um token:
- Acesse Configurações → Tokens de acesso (API)
- Clique em Novo token
- Informe:
- Nome e descrição: para que serve o token (ex.: "Script de automação")
- Organização: em qual organização o token atua
- Permissões (escopos): o que o token pode fazer (ler chamados, comentar, apontar tempo, anexos etc.)
- Data de expiração: quando o token deixa de ser válido (recomendado: 90 dias)
- IPs permitidos (opcional): faixas CIDR autorizadas a usar o token; vazio = qualquer IP
- Copie o token e guarde-o em local seguro (ele não será exibido novamente)
Tokens criados por usuários que não são administradores ou mantenedores da assinatura nascem aguardando aprovação e só funcionam depois que um administrador/mantenedor aprovar, na aba Tokens de acesso da tela de assinatura. Solicite a aprovação após criar o token.
O token vale apenas para os escopos concedidos, em interseção com as permissões do usuário que o criou. Se o criador for removido da organização ou da assinatura, o token é revogado automaticamente. Tokens antigos (formato UUID) foram descontinuados — gere um novo token.
Escopos disponíveis
| Escopo | O que permite |
|---|---|
tickets:read | Listar chamados e consultar detalhes |
tickets:write | Criar, atualizar e assumir chamados |
tickets:close | Concluir, reabrir e arquivar chamados |
comments:read | Ler comentários e checklists |
comments:write | Comentar e adicionar itens de checklist |
time:read | Ler apontamentos de tempo |
time:write | Criar/editar apontamentos e cronômetros |
attachments:read | Listar e baixar anexos |
attachments:write | Enviar anexos |
As permissões de um token podem ser editadas depois na tela de detalhes do token. Reduzir permissões vale na hora; ampliar permissões de um token aprovado o devolve para "aguardando aprovação" (exceto para administradores/mantenedores da assinatura).
Headers
x-api-key: ops_pat_seu_token_aqui
Content-Type: application/jsonA URL base da API é https://api.opsscript.io.
Principais recursos
Os recursos cobertos pelos escopos ficam disponíveis pela API — chamados, comentários, apontamentos de tempo, cronômetro e anexos. Métodos, parâmetros, payloads e exemplos de cada endpoint estão na Referência da API.
Exemplo de listagem de chamados:
curl -H "x-api-key: ops_pat_seu_token_aqui" \
https://api.opsscript.io/api/v1/ticketPor segurança, um token de acesso não gerencia outros tokens nem acessa rotas de assinatura/billing — a gestão de tokens é feita apenas pela interface.
[Assista o vídeo de APIs REST]
Erros
A API utiliza códigos de status HTTP padrão:
200 OK: Sucesso
201 Created: Recurso criado
400 Bad Request: Dados inválidos
401 Unauthorized: Token inválido, expirado, revogado ou aguardando aprovação
403 Forbidden: Sem permissão (fora do escopo do token ou IP não autorizado)
404 Not Found: Recurso não encontrado
500 Internal Server Error: Erro do servidorIntegrações nativas
O OpsScript possui integrações nativas com plataformas de comunicação para enviar notificações e replicar comentários de chamados:
- Slack — notificações, broadcasting e gatilhos em canais do Slack.
- Microsoft Teams — notificações e atualizações de chamados em canais do Teams.
A configuração de ambas é feita em Integrações, no menu lateral.
Acesso programático
Além da API REST, o OpsScript expõe suas principais funcionalidades por meio de um MCP server, que pode ser usado por IDEs e assistentes com IA compatíveis com o Model Context Protocol. Não há um SDK oficial: a automação é feita pela API REST (com token pessoal) ou pelo MCP server. Consulte IA e Automação para detalhes do MCP server.