Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt

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

Antes que seu aplicativo possa autenticar usuários da Vendaze, você precisa registrá-lo. O registro é aberto a qualquer desenvolvedor, sem processo de aprovação. Suas credenciais chegam por e-mail em segundos.
Ainda não tem uma conta na Vendaze? Crie gratuitamente. Novas contas incluem 14 dias de teste para você construir e validar sua integração antes de solicitar acesso de usuários reais.

​
O que você vai precisar

  • Um endereço de e-mail válido para receber as credenciais
  • Pelo menos uma URI de redirecionamento HTTPS para o callback OAuth
  • Uma decisão sobre quais escopos sua integração precisa

​
Registrar via API

Envie um POST para /v1/auth/register-app: 
curl -X POST https://api.vendaze.com/v1/auth/register-app \
  -H "Content-Type: application/json" \
  -d '{
    "app_name": "Minha Integração",
    "email": "dev@meuapp.com",
    "description": "Sincroniza contatos e negócios entre a Vendaze e o MeuApp",
    "avatar_url": "https://meuapp.com/assets/vendaze-avatar.webp",
    "redirect_uris": ["https://meuapp.com/oauth/callback"],
    "scopes": ["people:read", "people:write", "deals:read"]
  }'
Resposta (201): 
{
  "data": {
    "app_name": "Minha Integração",
    "client_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
    "message": "Credentials sent to dev@meuapp.com"
  }
}
Seu client_secret é enviado somente por e-mail e nunca retorna na resposta da API. Guarde-o com segurança assim que receber.

​
Parâmetros da requisição

ParâmetroTipoObrigatórioDescrição
app_namestringSimNome da integração exibido aos usuários na tela de consentimento. Máx. 100 chars.
emailstringSimE-mail para receber as credenciais. Um aplicativo por endereço de e-mail.
descriptionstringNãoDescrição curta do que seu app faz. Máx. 500 chars.
avatar_urlstringNãoURL HTTPS de uma imagem WebP exibida na tela de consentimento. Máx. 400×400 px.
redirect_urisstring[]SimUma ou mais URIs HTTPS para o callback OAuth. Correspondência exata obrigatória.
scopesstring[]SimEscopos que seu app precisa. Usuários aprovam individualmente.

​
URIs de redirecionamento

As URIs devem ser URLs HTTPS exatas. Curingas e padrões não são aceitos: 
Aceito:   https://meuapp.com/oauth/callback
Aceito:   https://meuapp.com/integracoes/vendaze/callback
Recusado: https://meuapp.com/oauth/*
Recusado: http://meuapp.com/callback
Durante o desenvolvimento local, http://localhost e http://127.0.0.1 são aceitos. Você pode registrar múltiplas URIs de redirecionamento para diferentes ambientes. Na hora da autorização, a redirect_uri da requisição precisa corresponder exatamente a uma das URIs registradas.

​
Escopos disponíveis

EscopoDescrição
people:readLer contatos (pessoas)
people:writeCriar, atualizar, deletar pessoas
companies:readLer empresas
companies:writeCriar, atualizar, deletar empresas
deals:readLer negócios
deals:writeCriar, atualizar, deletar negócios
tasks:readLer tarefas
tasks:writeCriar, atualizar, deletar tarefas
Solicitar um escopo durante o registro não garante que o usuário o aprove. Usuários podem aprovar ou recusar cada escopo individualmente durante o fluxo de consentimento.
Seu client_secret aparece apenas uma vez, no e-mail que você recebe após o registro. Se perdê-lo, você pode rotacionar suas credenciais usando o client_id e o e-mail cadastrado. Nunca o comite em repositórios ou inclua em código client-side.

​
Próxima etapa

Com seu client_id e client_secret, você está pronto para implementar o fluxo OAuth.

Autenticação

Implemente o fluxo OAuth 2.1 para autorizar usuários da Vendaze no seu aplicativo.

Rotacionar credenciais

Precisa atualizar o nome, URIs de redirecionamento ou escopos? Saiba como rotacionar suas credenciais.