Saltar para o conteúdo principal

​
Visão Geral da API

A API REST do SalesOS permite integrar a plataforma com seus sistemas internos, automações e ferramentas de terceiros.

​
Informações básicas

ItemValor
Base URLhttps://api.play2sell.com
ProtocoloHTTPS (obrigatório)
FormatoJSON
AutenticaçãoBearer Token (JWT via Auth0)
VersionamentoVia path (/v1/)
Rate Limit100 requisições/minuto por token

​
Autenticação

Todas as requisições à API exigem um token JWT válido no header Authorization: 
curl -X GET https://api.play2sell.com/v1/leads \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "Content-Type: application/json"
Consulte o guia de Autenticação para detalhes sobre como obter e renovar tokens.

​
Endpoints disponíveis

Leads

CRUD completo de leads: criar, listar, atualizar e excluir.

Vendas

Gerenciar oportunidades, etapas do pipeline e deals.

Usuários

Listar e gerenciar usuários e equipes.

Webhooks

Configurar webhooks para receber eventos em tempo real.

​
Padrões da API

​
Paginação

Endpoints que retornam listas suportam paginação: 
{
  "data": [...],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 150,
    "total_pages": 8
  }
}
Parâmetros: ?page=1&per_page=20

​
Respostas de erro

Erros seguem um formato padronizado: 
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "O campo 'email' é obrigatório.",
    "details": [...]
  }
}

​
Códigos HTTP

CódigoSignificado
200Sucesso
201Criado com sucesso
400Erro de validação
401Não autenticado
403Sem permissão
404Recurso não encontrado
429Rate limit excedido
500Erro interno do servidor

​
Filtros

Use query parameters para filtrar resultados: 
GET /v1/leads?status=qualified&created_after=2026-01-01&sort=-created_at
  • Prefixo - indica ordenação decrescente
  • Datas no formato ISO 8601
Use o header X-Request-ID para rastrear requisições. Se precisar de suporte, informe o request ID para facilitar a investigação.
A API está disponível apenas nos planos Professional e Enterprise. Verifique seu plano em Configurações > Plano.

​
Integrações

SalesOS Connect (n8n)

Automações visuais com n8n.

Omie ERP

Integração com o ERP Omie.

Integrações Custom

Crie suas próprias integrações.