Saltar para o conteúdo principal
POST
/
v1
/
auth
/
register-app
Registrar um aplicativo
curl --request POST \
  --url https://api.vendaze.com/v1/auth/register-app \
  --header 'Content-Type: application/json' \
  --data '
{
  "app_name": "Meu SaaS",
  "email": "dev@meusaas.com",
  "redirect_uris": [
    "https://meusaas.com/callback/vendaze"
  ],
  "scopes": [
    "people:read",
    "deals:write"
  ],
  "description": "Integração com a Vendaze para sincronizar contatos.",
  "avatar_url": "https://meusaas.com/assets/logo.webp"
}
'
{
  "data": {
    "app_name": "Meu SaaS",
    "client_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
    "avatar_url": "https://storage.vendaze.com/assets/integrations/meusaas.webp",
    "message": "Credentials sent by email."
  }
}

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.

Corpo

application/json
​
app_name
string
obrigatório
Maximum string length: 100
Exemplo:

"Meu SaaS"

​
email
string<email>
obrigatório
Exemplo:

"dev@meusaas.com"

​
redirect_uris
string<uri>[]
obrigatório
Exemplo:
["https://meusaas.com/callback/vendaze"]
​
scopes
enum<string>[]
obrigatório

Escopos que seu app precisa. Usuários aprovam individualmente na tela de consentimento.

Um escopo OAuth da Vendaze.

Opções disponíveis:
people:read,
people:write,
companies:read,
companies:write,
deals:read,
deals:write,
tasks:read,
tasks:write,
activities:read,
activities:write,
products:read,
products:write,
tags:read,
tags:write,
lists:read,
lists:write,
custom_fields:read,
custom_fields:write
Exemplo:
["people:read", "deals:write"]
​
description
string
Maximum string length: 500
Exemplo:

"Integração com a Vendaze para sincronizar contatos."

​
avatar_url
string<uri>

URL HTTPS do logo do seu app. A Vendaze faz o download da imagem, valida o formato pelo magic byte e armazena. Formatos aceitos: WebP, JPEG, PNG. Máx. 2MB.

Exemplo:

"https://meusaas.com/assets/logo.webp"

Resposta

Aplicativo registrado com sucesso.

​
data
object