Synup
Criar chave
v1Recursos/Connections/getObter uma URL de conexão do Google

Obter uma URL de conexão do Google

Retorna uma URL de autorização OAuth do Google para abrir em um navegador e conectar o Perfil da Empresa no Google deste local. Este endpoint não pode concluir a conexão sozinho — a tela de consentimento do Google requer um humano interativo.

get/api/v1/connections/google/connect-url
connections:write
Parâmetros de consulta
locationIdstringobrigatório
O local a conectar.
clientIdstringopcional
O cliente do local. Necessário apenas para desambiguar quando sua chave é limitada a clientes específicos.
returnUrlstringopcional
Caminho interno do app para onde ir após o humano concluir a tela de consentimento. Padrão: "/".
successUrlstringopcional
Para onde o navegador do cliente é enviado após uma conexão bem-sucedida. Deve estar registrada na chave de API e ser fornecida junto com errorUrl.
errorUrlstringopcional
Para onde o navegador é enviado se a conexão falhar ou for cancelada. Mesma regra de registro, e fornecida junto com successUrl.
Resposta
dataobjectopcional
providerstring (google | facebook | apple)opcional
Qual publisher esta URL conecta: google, facebook ou apple.
locationIdstringopcional
O local ao qual esta conexão é pareada, ou null quando a conexão foi iniciada com um clientId.
clientIdstringopcional
O cliente ao qual esta conexão é limitada, ou null.
urlstringopcional
A URL de autorização — abra-a em um navegador sob o controle do proprietário da conta.
successUrlstringopcional
A successUrl usada nesta chamada, ou null no modo legado.
errorUrlstringopcional
A errorUrl usada nesta chamada, ou null no modo legado.
notestringopcional
Orientações para abrir a URL. Explica o repasse de parceiro quando successUrl e errorUrl estão definidas, ou o fluxo de sondagem de GET /api/v1/connections caso contrário.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/connections/google/connect-url
Sua chave de API
locationId *
clientId
returnUrl
successUrl
errorUrl
{
  "data": {
    "provider": "google",
    "locationId": "loc_456",
    "clientId": null,
    "url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=...&redirect_uri=...&response_type=code&scope=...&state=...",
    "successUrl": "https://app.example.com/oauth/done",
    "errorUrl": "https://app.example.com/oauth/failed",
    "note": "Open this URL in a browser under the account owner's control. When the connect settles, the browser is sent to your successUrl (with ?code=...&status=...&connected_account_id=...) or errorUrl (with ?error=...). Exchange the code server-side at POST /api/v1/connections/handoff/exchange within 10 minutes for the connection id and the email that authorised."
  }
}

Guias que usam este endpoint