Início
XtreamUIPro

Tutorial

Ligue uma loja com um conector

Deixe a sua plataforma de faturação ou loja criar e renovar linhas por si própria: uma chave de API, o conector da sua plataforma, uma encomenda de teste e webhooks para o que acontece a seguir.

No final, uma encomenda paga na sua plataforma cria uma linha e cada pagamento renova-a, sem passar pelo painel. Precisa de uma conta de parceiro (revendedor) com créditos e pacotes que possa vender, e de uma plataforma com conector — WHMCS, Blesta, WISECP, HostBill, ClientExec, FOSSBilling, Paymenter, WordPress com WooCommerce ou Easy Digital Downloads, Odoo, PrestaShop, OpenCart, Magento, Dolibarr, ERPNext, ou Shopify, Upmind e Invoice Ninja através da ponte de webhooks.

Crie uma chave de API

Inicie sessão com a conta de parceiro e abra API Key. Uma chave é mostrada uma única vez, quando é criada — copie-a de imediato. Crie uma chave adicional por sistema, com um nome e os endereços autorizados a usá-la, para que uma possa ser revogada sem afetar as outras; o conector precisa de uma chave com permissão de escrita, por isso deixe a opção só de leitura desativada.

A página API Key de uma conta de parceiro: a chave, as chaves adicionais por sistema, os webhooks e as chamadas recentes.
A página API Key de uma conta de parceiro: a chave, as chaves adicionais por sistema, os webhooks e as chamadas recentes.

Escolha o conector

Abra Resources → All Connectors e escolha a sua plataforma. A página do conector lista os dados de ligação, os passos de instalação, um botão Download, o SHA-256 do ficheiro para o verificar e até que ponto esse conector foi testado — alguns correram dentro da plataforma real, outros tiveram apenas o núcleo exercitado. O código-fonte é aberto; os mesmos ficheiros são publicados no sítio dos conectores.

A página All Connectors: um cartão por plataforma, com a sua versão e até que ponto foi testado.
A página All Connectors: um cartão por plataforma, com a sua versão e até que ponto foi testado.

Instale-o na sua plataforma

Verifique o checksum e instale o ficheiro onde a página do conector indicar: a pasta de módulos do WHMCS, Blesta ou FOSSBilling, o carregamento de plugins do WordPress, a pasta de addons do Odoo, o instalador de extensões do OpenCart, e assim por diante. A ponte de webhooks para Shopify, Upmind e Invoice Ninja é uma pequena aplicação PHP que aloja por si próprio. Um conector limita-se a chamar a Reseller API com a sua chave: pode fazer o que a sua conta pode fazer, nada mais.

A página do conector WHMCS: dados de ligação, passos de instalação, a transferência e o seu SHA-256.
A página do conector WHMCS: dados de ligação, passos de instalação, a transferência e o seu SHA-256.

Configure-o

Nas definições do conector, introduza o endereço do servidor da API (o caminho /reseller/v1) e a chave e depois associe cada produto da sua plataforma a um pacote que o seu grupo possa vender. Os preços e o pagamento ficam na sua plataforma: o painel não recebe dinheiro e não tem gateway.

Faça uma encomenda de teste

Encomende o produto num ambiente de teste da sua plataforma. O conector chama create_line com o pacote e um id de pedido; a linha aparece em Lines com a duração do pacote como validade, e a sua plataforma recebe as respetivas credenciais. Uma renovação chama renew_line com o seu próprio id de pedido, pelo que uma nova tentativa após um erro de rede nunca é cobrada duas vezes. A página API Key lista as chamadas recentes com ação, resultado, código de erro, endereço e nome do conector.

A página Lines após uma encomenda de teste: a nova linha com o pacote, a validade e as ligações que o conector pediu.
A página Lines após uma encomenda de teste: a nova linha com o pacote, a validade e as ligações que o conector pediu.

Adicione webhooks (opcional)

Na página API Key, adicione um endpoint de webhook (um endereço https da sua plataforma) para os eventos pretendidos: line.created, line.renewed, line.enabled, line.disabled, line.deleted, line.expiring, line.expired, credits.low. Cada notificação é assinada com o segredo mostrado uma única vez na criação (X-Xtream-Signature) e nunca transporta uma palavra-passe; o botão Test envia uma de imediato.

Tópicos de ajuda relacionados

Próximos tutoriais