Business Management APIs

Business On Behalf Of

La API de On Behalf Of permite a un socio lo siguiente:

  • Obtener acceso para actuar en nombre de su cliente
  • Crear un usuario del sistema en el administrador comercial del cliente y obtener el token de acceso

Un usuario del sistema se define como alguien que puede realizar tareas programáticas repetitivas, como actualizar un catálogo de productos, enviar eventos del servidor a servidor, o actualizar audiencias personalizadas, etc.

En esta situación, el usuario del sistema tiene acceso de empleados y solo puede hacerlo a recursos asignados (en el momento de la creación) con el token de acceso del usuario administrador.

La ventaja de usar un usuario del sistema en comparación con un token de acceso propio de usuario es que los usuarios pueden desconectar un negocio, pero los tokens de acceso de usuario del sistema no caducan. En este sentido, el cliente sigue siendo el propietario del negocio y permite al socio acceso al administrador comercial y a los recursos a través de un usuario del sistema. Un cliente tiene la capacidad de acudir al administrador comercial y revocar el usuario del sistema o eliminar con programación el acceso de ciertos recursos a un socio.

Primeros pasos

Antes de empezar, recomendamos revisar estos requisitos y esta información:

Administrador comercial de clientes

Si tu cliente creó una cuenta comercial a través del administrador de ventas, dicha cuenta ya está conectada a tu administrador comercial. Puedes encontrar tu identificador del administrador comercial siguiendo esta instrucción.

Si no hay administrador comercial del cliente, debes crear uno antes de continuar. Para obtener instrucciones, consulta la API del administrador comercial.

Permisos de la aplicación

  • business_management

Identificaciones

  • PARTNER_BM_ID: identificador del administrador comercial del socio que debería ser el propietario de la app.
  • CLIENT_BM_ID: identificador del administrador comercial del cliente propietario de la página de Facebook conectada a la cuenta comercial del cliente.

Tokens de acceso

  • USERS_ACCESS_TOKEN: el token de acceso de un administrador del administrador comercial del cliente, que se creó con los permisos business_manage usando la app propiedad del administrador comercial del socio. Este token se genera mediante el inicio de sesión con Facebook.
  • PARTNER_BM_ADMIN_SYSTEM_USER_ACCESS_TOKEN: el token de acceso del usuario administrador del sistema en el administrador comercial del socio de la app.
  • CLIENT_BM_SU_ACCESS_TOKEN: el token de acceso del usuario del sistema en el administrador comercial del cliente.
  • CLIENT_BM_SU_PAGE_ACCESS_TOKEN: el token de acceso a la página del usuario del sistema en el administrador comercial del cliente.

Pasos recomendados

Paso 1

Crea la relación On Behalf Of entre el socio y el administrador comercial del cliente.

Esto crea una ventaja de relación entre el administrador comercial del socio y el administrador de negocios del cliente. Esto permite que el socio pueda crear un usuario del sistema mediante la API en el siguiente paso.

Token de acceso usado:USERS_ACCESS_TOKEN


curl -i -X POST \
 "https://graph.facebook.com/v19.0/<PARTNER_BM_ID>/managed_businesses?existing_client_business_id=<CLIENT_BM_ID>&access_token=<USERS_ACCESS_TOKEN>"

Paso 2

Obtenga el token de acceso del usuario del sistema en el administrador comercial del cliente. De esta manera, se instala la app en el administrador comercial del cliente y crea un usuario del sistema. Por defecto, el nombre del usuario del sistema es "{Client_Business_Manager_Name} SYSTEM USUARIO". Un cliente podrá ver la app de socios en su administrador comercial como recurso compartido (a los sumo, solo tendrá acceso a la app como usuario de prueba).

En el parámetro scope, debes incluir todos los permisos que necesites que tenga el usuario del sistema para acceder a los puntos de conexión relevantes de la API. Consulte las referencias individuales de la API para saber qué permisos se necesitan para acceder a ellas.

Token de acceso usado:PARTNER_BM_ADMIN_SYSTEM_USER_ACCESS_TOKEN. Este token de acceso necesita tener el permiso business_management y todos los permisos incluidos en los parámetros scope anteriores.


curl -i -X POST \
 "https://graph.facebook.com/v19.0/<CLIENT_BM_ID>/access_token?scope=ads_management,pages_read_engagement&app_id=<APP_ID>&access_token=<PARTNER_BM_ADMIN_SYSTEM_USER_ACCESS_TOKEN>"

La respuesta contiene el token del usuario del sistema que está vinculado a las relaciones "On Behalf Of". No es necesario crear ni utilizar ningún otro usuario del sistema para realizar la integración comercial.

Paso 3

Obtén el identificador del usuario del sistema.

Token de acceso usado:CLIENT_BM_SU_ACCESS_TOKEN

curl -i -X GET \
 "https://graph.facebook.com/v19.0/me?access_token=<CLIENT_BM_SU_ACCESS_TOKEN>"

Paso 4

Asigna recursos (página y catálogo) al usuario del sistema en el administrador comercial del cliente.

Token de acceso usado:USERS_ACCESS_TOKEN

curl -i -X POST \
 "https://graph.facebook.com/v19.0/<ASSET_ID>/assigned_users?user=<SYSTEM_USER_ID>&tasks=MANAGE&access_token=<USERS_ACCESS_TOKEN>"

Paso 5

Almacena este CLIENT_BM_SU_ACCESS_TOKEN en una base de datos segura y úsalo para acceder a las API que requieren un token de acceso de usuario, como el administrador de catálogos.

Paso 6

Genera un token de acceso a la página usando CLIENT_BM_SU_ACCESS_TOKEN realizando la siguiente llamada:

curl -i -X GET \
 "https://graph.facebook.com/v19.0/me/accounts?access_token=<CLIENT_BM_SU_ACCESS_TOKEN>"

Esta solicitud incluirá todas las páginas administradas por el usuario del sistema, incluida la coincidencia access_token. Ejemplo de respuesta:

{
  "data": [
    {
      "access_token": "<access token sanitized>",
      "category": "Retail Company",
      "category_list": [
        {
          "id": "2239",
          "name": "Retail Company"
        }
      ],
      "name": "Test_Shop_Page",
      "id": "<content sanitized>",
      "tasks": [
        "ANALYZE",
        "ADVERTISE",
        "MODERATE",
        "CREATE_CONTENT",
        "MANAGE"
      ]
    }
  ],
  "paging": {
    "cursors": {
      "before": "<content sanitized>",
      "after": "<content sanitized>"
    }
  }
}

Copia el access_token correspondiente en la página vinculada a la cuenta comercial del cliente y guárdalo de forma segura. Lo utilizarás para acceder a las API que requieren un token de acceso a la página en nombre de la cuenta comercial, como administración de pedidos e informes financieros.

Preguntas frecuentes

¿Cómo puedo borrar la relación "On Behalf of" para eliminar el usuario del sistema en el administrador comercial del cliente que me asignaron?


curl -i -X DELETE \
 "https://graph.facebook.com/v19.0/<PARTNER_BM_ID>/managed_businesses?existing_client_business_id=<CLIENT_BM_ID>&access_token=<USERS_ACCESS_TOKEN>"

Si el cliente quiere eliminar la conexión y el usuario del sistema del socio, puedes hacerlo en la vista de la app del administrador comercial.