Plataforma e API
Uma plataforma concebida para ser automatizada e ampliada
Tudo o que a área de administração faz, a API REST também faz. E, quando precisa de alterar o comportamento do núcleo, os hooks de eventos permitem intervir sem modificar uma linha do seu código.
A API REST
Gira toda a operação através de uma única API
A área de administração e a API partilham o mesmo mapa de permissões, pelo que tudo o que um membro da equipa pode fazer também pode ser feito por um token. Os clientes dispõem de uma interface própria com acesso limitado.
# Create a client straight from your own signup flow
curl -X POST https://yourdomain.com/api/v1/clients \
-H "Authorization: Bearer $WISECP_TOKEN" \
-d '{
"first_name": "Ada",
"last_name": "Lovelace",
"email": "[email protected]",
"country": "GB"
}'
# 201 Created
{ "status": "success", "data": { "id": 4821, "state": "active" } }
// Create a client straight from your own signup flow
$api = new WisecpClient(getenv('WISECP_TOKEN'));
$client = $api->clients->create([
'first_name' => 'Ada',
'last_name' => 'Lovelace',
'email' => '[email protected]',
'country' => 'GB',
]);
echo $client->id; // 4821
// Create a client straight from your own signup flow
const api = new WisecpClient(process.env.WISECP_TOKEN);
const client = await api.clients.create({
firstName: 'Ada',
lastName: 'Lovelace',
email: '[email protected]',
country: 'GB',
});
console.log(client.id); // 4821
# List the signed-in client's unpaid invoices
curl https://yourdomain.com/api/v1/client/invoices?status=unpaid \
-H "Authorization: Bearer $CLIENT_TOKEN"
# 200 OK
{
"status": "success",
"data": [
{ "id": 90233, "total": "42.00", "due": "2026-08-01" }
]
}
// List the signed-in client's unpaid invoices
$api = new WisecpClient(getenv('CLIENT_TOKEN'));
$invoices = $api->client->invoices->all([
'status' => 'unpaid',
]);
foreach ($invoices as $invoice) {
echo $invoice->total;
}
// List the signed-in client's unpaid invoices
const api = new WisecpClient(process.env.CLIENT_TOKEN);
const invoices = await api.client.invoices.all({
status: 'unpaid',
});
invoices.forEach(i => console.log(i.total));
Hooks de eventos
Altere o comportamento do núcleo sem o modificar
Cada pedido percorre um caminho pela plataforma. Em cada etapa, um hook pode intercetá-lo, transformar os seus dados, acrescentar elementos à interface ou bloqueá-lo por completo, tudo a partir do seu próprio código.
Ações
Reaja a um evento: envie, registe, sincronize ou desencadeie o seu próprio fluxo de trabalho.
Extensões da interface
Adicione campos, painéis e botões aos ecrãs de administração e de cliente.
Filtros
Transforme um valor antes de o núcleo o utilizar, desde preços até dados de pedidos.
Controlos
Vete uma ação por completo: bloqueie uma encomenda, fatura, início de sessão ou suspensão.
Registos
Registe o seu próprio tipo de produto, rota ou tarefa cron agendada.
Módulos
Ligue qualquer sistema com um módulo
Nove tipos de módulos documentados abrangem os sistemas que pode ligar, desde painéis de controlo até meios de pagamento. Cada tipo inclui uma estrutura inicial, para começar com código funcional.
Servidores
Painéis de controlo de alojamento e servidores, com criação, suspensão, SSO e estatísticas de utilização.
Pagamentos
Meios de pagamento em quatro modelos: merchant, subscrição, terceiros e tokenização.
Agentes de registo
Agentes de registo de domínios com uma interface de mais de quarenta funções.
Produtos
Tipos de produtos personalizados com o seu próprio ciclo de ativação e gestão.
Complementos
Complementos que se associam a qualquer produto ou serviço.
SMS
Fornecedores de SMS para notificações e códigos de verificação.
Fornecedores de e-mail para envios transacionais e em massa.
Autenticação
Fornecedores de autenticação social e início de sessão único.
Encaminhamento de e-mail
Transforme automaticamente e-mails recebidos em pedidos de suporte.
Arquitetura
Um núcleo leve, otimizado para a velocidade
O núcleo da v5 utiliza uma framework própria e leve, com um percurso rápido dedicado à API, para manter uma arquitetura moderna e rápida sob carga.
Núcleo leve
Um núcleo MVC próprio (coremio), concebido para um elevado débito de processamento.
Percurso rápido da API
Os pedidos da API passam por um núcleo leve, sem percorrer a camada MVC.
Ambiente de execução moderno
Funciona com PHP 8.2 e versões posteriores, atuais e com suporte.
OpenAPI 3.1
Documentação gerada a partir do código, com verificação de divergências durante a compilação.
Começar a desenvolver
Tudo o que precisa para desenvolver
A referência da API, o catálogo de hooks e os guias de módulos estão na documentação para programadores, com modelos iniciais que pode adaptar.