POST/api/v4/connected-accounts/connect-facebook

Conectar uma conta do Facebook

Retorna uma URL OAuth para vincular uma conta do Facebook Pages à sua conta da Listings API.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Corpo

NomeTipoObrigatórioDescrição
inputobjectobrigatórioWrapper object. The entire request body must be nested under `input`.
input.successUrlstringobrigatórioURL the user is redirected to after they successfully authorize Facebook. Must be an absolute https URL you control.
input.errorUrlstringobrigatórioURL the user is redirected to if they cancel or the authorization fails. Must be an absolute https URL you control.

Exemplo de requisição

Corpo pronto para colar. Substitua os IDs e valores de exemplo pelos seus.

Request body
{  "input": {    "successUrl": "https://listingsapi.com/docs/api/connected-accounts-trigger-matches",    "errorUrl": "https://listingsapi.com/docs/api/connected-accounts-connect-facebook"  }}

Respostas

200OAuth URL generated successfully. Redirect the user to `url` to begin the Facebook authorization flow. The `url` shown is a placeholder; send the user to the `url` returned in your own response.
Response
{  "data": {    "bulkConnectLinkForFacebook": {      "errors": null,      "success": true,      "url": "https://connect.example.com/oauth?token=8f3c1d92-..."    }  }}
400Bad request, the body was not wrapped in `input`, or `successUrl`/`errorUrl` was omitted (error message: `Variable "$input" of required type "FacebookOauthBulkInput!" was not provided`).
401Unauthenticated, missing or invalid API key.

Gera uma URL OAuth de curta duração que um usuário acessa para autorizar a Listings API a gerenciar suas páginas do Facebook em massa. Redirecione o usuário para url retornado; durante o fluxo, ele analisa e aceita os termos do Facebook e concede as permissões de gerenciamento de páginas necessárias para a Listings API. O link é válido por 24 horas.

Estrutura da requisição. O corpo deve estar encapsulado em um objeto input contendo dois campos obrigatórios, successUrl e errorUrl. Essas são as URLs https absolutas para as quais o usuário é redirecionado após concluir (ou abandonar) o fluxo de autorização do Facebook; informe endpoints da sua própria aplicação que retomem a integração inicial em caso de sucesso e ofereçam uma nova tentativa em caso de erro. Não há um campo accountId, o link de conexão sempre tem como escopo a conta à qual pertence a chave de API, e o envio de accountId (ou de um corpo sem encapsulamento) é rejeitado com HTTP 400.

Este é o equivalente para o Facebook do endpoint connect-google e a primeira etapa do fluxo de conexão em massa. Após a autorização, a conta aparece em GET /connected-accounts com um connectedAccountId usado para correspondência e sincronização.

Caso de uso: integração inicial das páginas de um cliente no Facebook. Depois que um cliente conceder acesso ao Facebook, redirecione-o para url retornado. Quando ele concluir, execute POST /connected-accounts/trigger-matches, analise os resultados com GET /connected-accounts/{connectedAccountId}/connection-suggestions e confirme as associações por meio de POST /connected-accounts/confirm-matches para que os dados das páginas do Facebook comecem a ser sincronizados com os locais correspondentes da Listings API.

Caso de uso: nova autorização após a recusa de permissões. Se um usuário ignorar uma permissão obrigatória do Facebook, a conexão não poderá sincronizar. Emita o link novamente e peça que ele autorize de novo, concedendo todas as permissões.

Para o Google, use o endpoint connect-google. success: true com um url não nulo significa que o link foi gerado; errors é preenchido somente quando a geração falha.

Request
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/connect-facebook' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "successUrl": "https://listingsapi.com/docs/api/connected-accounts-trigger-matches",      "errorUrl": "https://listingsapi.com/docs/api/connected-accounts-connect-facebook"    }  }'