/api/v4/locations/oauth_connect_urlConectar um local ao Apple Business Connect
Cria um link OAuth do Apple Business Connect para publicar um local no Apple Maps via ListingsAPI e a conta Apple Business verificada do proprietário.
Parâmetros
Corpo
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| input | object | obrigatório | Wrapper object. The entire request body must be nested under `input`. |
| input.locationId | string | obrigatório | Location to connect. Accepts a Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID. |
| input.site | string | obrigatório | Set to `APPLE`. |
| input.successUrl | string | obrigatório | Absolute URL in your application the owner returns to after granting access. |
| input.errorUrl | string | obrigatório | Absolute URL in your application the owner returns to if they cancel or the grant fails. |
Exemplo de requisição
Corpo pronto para colar. Substitua os IDs e valores de exemplo pelos seus.
{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "APPLE", "successUrl": "https://app.example.com/locations/1800289/apple/connected", "errorUrl": "https://app.example.com/locations/1800289/apple/connect-failed" }}Respostas
200A single-use link to send the owner to. `errors` is `null` on success. The `url` shown is a placeholder; send the owner to the `url` returned in your own response.
{ "data": { "createConnectUrl": { "success": true, "url": "https://connect.example.com/oauth?token=8f3c1d92-...", "errors": null } }}401Unauthenticated, missing or invalid API key.
403The key is valid but not permitted to connect this location (`SY90003`).
Use esta opção quando o proprietário da empresa tiver uma conta de organização verificada no Apple Business. Encaminhe o proprietário para url; ele faz login no Apple Business Connect, concede acesso e retorna para successUrl. A partir daí, o ListingsAPI publica o nome, a categoria, o endereço, o telefone, o site e os horários desse local no Apple Maps por meio da conta do proprietário. Se ele cancelar ou a concessão de acesso falhar, ele retorna para errorUrl e nada é conectado.
Se o proprietário não tiver uma conta de organização verificada no Apple Business, pule esta chamada. O ListingsAPI publica o local por meio de sua própria conta no Apple Business Connect, e a Apple verifica o envio antes de publicá-lo.
A Apple conecta um local por link. Para conectar vários locais, crie um link para cada um. Ambas as URLs de redirecionamento devem ser absolutas; um valor relativo ou que não possa ser interpretado é retornado como success: true com um null url, portanto, verifique url antes de redirecionar. O link é de uso único, portanto, crie um novo a cada tentativa.
Confirmar a conexão
Depois que o proprietário retornar para successUrl, chame Listar contas conectadas com publisher=AppleAccount. Um status com valor CONNECTED significa que as atualizações passam pela conta do proprietário. MATCH_IN_PROGRESS ou CONNECTIVITY_ISSUE significa que o proprietário precisa abrir um novo link de conexão.
Para parar de publicar por meio da conta do proprietário, use Desconectar um local do Apple Business Connect. Para ver o fluxo completo, incluindo como verificar a listagem no Apple Maps, consulte Conectar o Apple Business Connect.
Esta página documenta o caso site: "APPLE" de Criar uma URL de conexão OAuth para um local.
Este endpoint cria credenciais OAuth reais. A solicitação e a resposta de exemplo acima são exemplos.
curl -X POST 'https://listingsapi.com/api/v4/locations/oauth_connect_url' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "APPLE", "successUrl": "https://app.example.com/locations/1800289/apple/connected", "errorUrl": "https://app.example.com/locations/1800289/apple/connect-failed" } }'