Synup
Crear clave
v1Recursos/Connections/getObtener una URL de conexión de Apple

Obtener una URL de conexión de Apple

Devuelve una URL de autorización de Apple Business Connect para abrir en un navegador. Acepta locationId o clientId, al menos uno; cuando se proporciona locationId, el listado se vincula del lado del servidor sin paso de selección.

get/api/v1/connections/apple/connect-url
connections:write
Parámetros de consulta
locationIdstringopcional
La ubicación a conectar. Opcional para Apple: pasa locationId o clientId, al menos uno.
clientIdstringopcional
El cliente de la ubicación. Solo necesario para desambiguar cuando su clave está limitada a clientes específicos.
successUrlstringopcional
A dónde se envía el navegador del cliente tras una conexión exitosa. Debe estar registrada en la clave de API y proporcionarse junto con errorUrl.
errorUrlstringopcional
A dónde se envía el navegador si la conexión falla o se cancela. Misma regla de registro, y se proporciona junto con successUrl.
Respuesta
dataobjectopcional
providerstring (google | facebook | apple)opcional
Qué publisher conecta esta URL: google, facebook o apple.
locationIdstringopcional
La ubicación a la que se empareja esta conexión, o null cuando la conexión se inició con un clientId.
clientIdstringopcional
El cliente al que se limita esta conexión, o null.
urlstringopcional
La URL de autorización — ábrala en un navegador bajo el control del propietario de la cuenta.
successUrlstringopcional
La successUrl usada en esta llamada, o null en modo heredado.
errorUrlstringopcional
La errorUrl usada en esta llamada, o null en modo heredado.
notestringopcional
Indicaciones para abrir la URL. Explica el traspaso de partner cuando successUrl y errorUrl están definidas, o el flujo de sondeo de GET /api/v1/connections en caso contrario.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/connections/apple/connect-url
Su clave 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."
  }
}

Guías que usan este recurso