Synup
Criar chave
v1Recursos/Connections/getObter uma URL de conexão da Apple

Obter uma URL de conexão da Apple

Retorna uma URL de autorização do Apple Business Connect para abrir em um navegador. Aceita locationId ou clientId, pelo menos um; quando locationId é fornecido, a listagem é vinculada no servidor, sem etapa de seleção.

get/api/v1/connections/apple/connect-url
connections:write
Parâmetros de consulta
locationIdstringopcional
O local a conectar. Opcional para Apple: informe locationId ou clientId, pelo menos um.
clientIdstringopcional
O cliente do local. Necessário apenas para desambiguar quando sua chave é limitada a clientes específicos.
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/apple/connect-url
Sua chave de API
locationId
clientId
successUrl
errorUrl
{
  "data": {
    "provider": "apple",
    "locationId": "loc_456",
    "clientId": null,
    "url": "https://businessconnect.apple.com/authorize?client_id=...&redirect_uri=...&scope=...&state=...",
    "successUrl": null,
    "errorUrl": null,
    "note": "Open this URL in a browser under the account owner's control. Apple's account represents the business itself, so with a locationId supplied the listing binds server-side with no picker step. There is no callback; poll GET /api/v1/connections, or pass successUrl and errorUrl to get a one-time code back."
  }
}

Guias que usam este recurso