Primeiros Passos

A API externa do hostmgr permite a comunicação entre uma plataforma própria e sua instalação HOSTMGR.

URL Base

O HOSTMGR é instalado no seu servidor, portanto, a URL da api varia de acordo com seu domínio e local de instalação do sistema.

A comunicação é feita usando a seguinte URL base.

http://seudominio.com.br/url/do/seu/hostmgr/api/seudominio.com.br

Autenticação

A autenticação é realizada por meio de tokens que devem ser criados através do Admin. Menu Configurações -> Geral -> Token API

Ao criar o token você pode restringir o acesso a um grupo de IP’s ou não.

Para autenticação da transação você deve enviar o token no header chamado hostmgr-token e informar o token/key previamente gerado.

Métodos de Envio

Todas as requisições devem ser enviadas adotando o seguinte método de envio:

GET: Consultas

POST: Novo registro

PUT: Atualizar Registro

DELETE: Excluir Registro

Padrão de Envio de dados

Todos os dados que serão gravados no sistema devem ser enviados no formato JSON, e os dados também serão devolvidos nesse padrão.