Recursos do Partner Console
O Partner Console inclui quatro seções principais, acessíveis pelas guias de navegação:
1. Chaves Secretas
Gerencie suas chaves secretas de API com controle total sobre tipos de acesso e permissões.
Principais recursos:
- Create New Keys - Gere novas chaves de API com níveis de acesso específicos
- Tipos de chave:
- Live - Acesso total de leitura e gravação aos dados de produção
- Dryrun - Teste operações de gravação sem afetar os dados de produção (as gravações são simuladas)
- Read-only - Acesso somente leitura para consumo seguro de dados (operações de gravação bloqueadas)
- Gerenciamento de chaves - Visualize detalhes das chaves e carimbos de data/hora do último uso, faça a rotação de chaves e revogue chaves instantaneamente
- Filtragem de chaves - Filtre as chaves por status (All, Active, Revoked)
- Rotação de chaves - Faça a rotação de chaves sem interrupção do serviço
Cada chave secreta exibe:
- Label - Nome personalizável para facilitar a identificação
- Key ID - Identificador exclusivo (formato UUID)
- Secret - Chave secreta parcialmente ocultada (os primeiros 12 e os últimos 4 caracteres ficam visíveis)
- Type - Nível de acesso da chave (live, dryrun, read-only)
- Status - Estado atual (active, revoked)
- Created - Data em que a chave foi gerada
- Last Used - Carimbo de data/hora da chamada de API mais recente
- Actions - Fazer a rotação ou revogar a chave
2. Configurações de Integração
Configure como sua integração se vincula às instalações do Performance Hub.
Principais recursos:
- Data Linking Method - Escolha entre dois métodos de vinculação:
- Direct Link - Use os IDs de instalação do Performance Hub nas chamadas de API
- Linking Identifier - Use seus próprios identificadores de local (Branch ID, Store Number etc.)
- Saiba mais sobre os métodos de vinculação de parceiros
- Linking Identifier Label - Personalize o nome do campo exibido para as instalações (por exemplo, "Branch ID", "Location Code")
- Partner Prefix - Defina um prefixo exclusivo para suas integrações
- Integration Fields - Configure campos personalizados específicos da sua integração
3. Detalhes do Parceiro
Visualize e gerencie as informações do seu perfil de parceiro.
Campos editáveis:
- Partner Email - E-mail de contato principal para notificações
- Description - Breve descrição da sua integração
- Logo URL - URL do logotipo do parceiro
- Website - Site da sua empresa ou integração
- Category - Classificação da categoria da integração
- Details - Informações adicionais do parceiro
Informações somente leitura:
- ID do parceiro (identificador exclusivo)
- Nome do parceiro
- Status da integração
- Número de organizações conectadas
4. Logs
Monitore a atividade da API e solucione problemas de integração.
Dados disponíveis:
- Logs de solicitações de API
- Códigos de status de resposta
- Mensagens de erro
- Informações de data e hora
- Payloads de solicitação/resposta
Organizações Conectadas
Visualize todas as organizações que ativaram sua integração. Cada cartão de organização exibe:
- Nome da organização
- Marcas associadas
- Número de instalações ativas
- Status da integração
Ask AI
Obtenha ajuda instantânea sobre temas relacionados a parceiros usando o assistente de IA (atalho ⌘I).
Pergunte sobre:
- Uso e exemplos de endpoints da API
- Autenticação e gerenciamento de chaves secretas
- Práticas recomendadas de sincronização de dados
- Solução de problemas comuns de integração
- Recursos e navegação do Partner Console