Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.play2sell.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Gerenciamento de API Keys

Com sua chave em mãos, teste requisições assinadas no navegador no Sandbox da API — cole a API key e o secret, e o playground assina as requisições automaticamente.
API keys permitem que suas integrações se autentiquem no SalesOS usando o esquema de requisições assinadas P2S-SIGN-V1. As chaves são criadas e gerenciadas exclusivamente pelo Dashboard do SalesOS.
O gerenciamento de API keys requer a capability admin.integrations. Owners e admins do tenant possuem isso por padrão.

​
Criar uma chave

1

Abra o Dashboard

Acesse dashboard.play2sell.com (ou staging) e faça login com sua conta de administrador.
2

Navegue até API Keys

Vá em Integrações > API Keys no menu lateral.
3

Crie uma nova chave

Clique em Criar API Key e preencha:
  • Nome — Um nome descritivo (ex.: “Sincronização CRM Noturna”, “Formulários do Site”)
  • Escopo — Selecione default:sync para integrações padrão
  • Rate limit — Requisições por hora (padrão: 1.000)
  • Expiração — Data de expiração opcional
4

Copie os dois valores

Após a criação, o Dashboard exibe dois valores, apenas uma vez:
  • API Key — identificador público, ex. sk_live_a1b2c3d4.... Enviado no header Authorization em toda requisição assinada.
  • API Key Secret — usado para calcular a assinatura da requisição. Nunca trafega pela rede.
Copie os dois imediatamente e guarde em local seguro (variáveis de ambiente, gerenciador de segredos).
O API Key Secret é exibido apenas uma vez na criação. Se você perder, revogue a chave e crie uma nova — não há como recuperar o secret.

​
Gerenciar chaves existentes

A mesma tela Integrações > API Keys permite:
  • Visualizar todas as chaves ativas, revogadas e expiradas (o secret nunca é exibido novamente)
  • Revogar uma chave — para de funcionar imediatamente, preservando o histórico de auditoria
  • Excluir uma chave — remove permanentemente (prefira revogar)
  • Monitorar uso — veja contagem de requisições e data do último uso

​
Escopos disponíveis

EscopoConcede acesso a
default:syncEndpoints sync_collaborators e sync_activities
leads:readLeitura de dados de leads
leads:writeCriação e atualização de leads
Um conjunto de scopes vazio significa que a chave não tem restrição de escopo — pode acessar qualquer endpoint que aceite autenticação por API key.

​
Boas práticas

Crie chaves separadas para cada integração (sincronização CRM, formulários do site, API de parceiros). Assim, se uma chave for comprometida, você só precisa rotacionar aquela.
Chaves sem expiração vivem para sempre. Defina uma data de expiração para forçar rotação regular — 90 dias é um bom padrão.
Se uma chave só precisa sincronizar atividades, dê apenas default:sync. Não deixe escopos vazios a menos que a chave realmente precise de acesso total.
Verifique a contagem de requisições e a data do último uso na tela de listagem do Dashboard. Chaves não usadas há meses podem ser candidatas a revogação.
  1. Crie uma nova chave no Dashboard
  2. Atualize sua integração para usar a nova chave + secret
  3. Verifique que a nova chave funciona
  4. Revogue a chave antiga

​
Próximos passos

Autenticação

Conheça o esquema de assinatura P2S-SIGN-V1 com exemplos de código

Integração Activities

Comece a enviar atividades com sua nova chave