HOSTMGR Desenvolvedores
  • Bem Vindo
  • Entre em contato
  • Por onde começar?
  • Interação com a base de dados (MySQL)
  • Modulo de Licenças
    • Sobre
  • MÓDULOS DE INTEGRAÇÃO
    • Provisionamento (Servidores)
      • Criando o Módulo
      • Funções do módulo
    • Formas de Pagamento
      • Criando o módulo
      • Retorno Automático
    • Tarefas Cron
    • Webhooks
      • Criando uma Hook
      • Arquivo de Exemplo de Hook
      • Desativar Arquivo de Hook
      • Hooks/Gatilhos Disponíveis
    • Widgets
    • Módulos Adicionais (extras)
      • Criando um módulo extra
      • Webhook do Modulo
  • API
    • Introdução
    • Primeiros Passos
    • Exemplos de Requisição
  • API REFERENCE
    • Clientes
    • Faturas
    • Contas/Serviços
    • Dominios
Powered by GitBook
On this page
  • URL Base
  • Autenticação
  • Métodos de Envio
  • Padrão de Envio de dados
  1. API

Primeiros Passos

PreviousIntroduçãoNextExemplos de Requisição

Last updated 1 year ago

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.

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.

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