Métodos de vinculação de parceiros

Parceiros ou sistemas de gestão de membros diferentes identificam cada instalação ou local pelo próprio ID, como um ID de filial, número de loja ou ID de instalação. Temos duas formas de identificar locais durante a sincronização ou o envio de dados.

1. Link Direto

Ao enviar dados, o parceiro usará o ID da instalação do sistema Performance Hub.

Por exemplo, para o Parceiro A, o ID interno de uma instalação em Tóquio é branch_tokyo. Mas, para normalizar os dados no ecossistema do Performance Hub, atribuímos um novo ID para esse local e esse parceiro, por exemplo, o UUID 550e8400-e29b-41d4-a716-446655440000.

Os parceiros devem usar esse facility_id ao chamar nossas APIs para enviar dados.

Para obter o facility_id correto para a vinculação (conforme exigido no método Direct Link), os parceiros podem chamar o endpoint de API /partner/v1/facilities. Esse endpoint retorna uma lista de todas as instalações que atualmente têm sua integração de parceiro ativada no Performance Hub, junto com os valores de facility_id correspondentes.

Exemplo: Direct Link

curl -X POST https://partner-api.performancehub.co/partner/v1/membership-plans \
  -u sk_live_YOUR_PARTNER_SECRET_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "membership_plans": [
      {
        "membership_plan_id": "plan_unlimited_monthly",
        "facility_id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Unlimited Monthly Access",
        "billing_cycle": "monthly",
        "price": 10058,
        "currency": "JPY"
      }
    ]
  }'

2. Identificador de Vínculo

O parceiro mantém o próprio sistema com identificadores exclusivos para cada local (por exemplo, "Branch ID", "Location Code", "Store Number"). Esse método de vinculação permite que o parceiro identifique as instalações do Performance Hub usando o próprio identificador, em vez do nosso ID de instalação.

Configuração da instalação: quando uma instalação ativa esse parceiro, ela precisa informar, na configuração da instalação no Performance Hub, o identificador exclusivo que o parceiro usa para identificar esse local.

Integração por API: quando o parceiro faz chamadas de API ao Performance Hub, ele pode informar o próprio identificador exclusivo na solicitação. O Performance Hub consulta internamente o linking_identifier para associar a chamada de API à instalação correta.

Exemplo: se o parceiro chama os locais de "Branch ID" no sistema dele, defina o rótulo abaixo como "Branch ID". Cada instalação informará então o valor do seu Branch ID ao ativar a integração, permitindo a sincronização de dados contínua entre os sistemas.

Exemplo de configuração da tela de integrações de uma instalação (visualização principal da instalação no Performance Hub) mostrando o identificador de vinculação / ID interno do sistema de gestão de membros configurado na tela de integrações de parceiros

Exemplo: Linking Identifier

curl -X POST https://partner-api.performancehub.co/partner/v1/membership-plans \
  -u sk_live_YOUR_PARTNER_SECRET_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "membership_plans": [
      {
        "membership_plan_id": "plan_unlimited_monthly",
        "linking_identifier": "branch_tokyo",
        "name": "Unlimited Monthly Access",
        "billing_cycle": "monthly",
        "price": 10058,
        "currency": "JPY"
      }
    ]
  }'