Introdução

A API MikWeb possibilita com que você integre suas aplicações ou ainda aplicações de terceiros a sua conta MikWeb.

A API segue o padrão REST, usando o protocolo HTTP tendo como retorno objetos JSON. Isso faz com que a API possua ampla compatibilidade com as principais tecnologias disponíveis no mercado.

Todos os recursos são entregues com segurança garantida através da criptografia ponto a ponto do protocolo SSL, autenticação baseada em Token e controle de permissões.

Tudo isso mantendo a usabilidade, alta disponibilidade e total rastreabilidade.

Endpoint da API

As requisições devem ser destinadas a URL abaixo, onde a API MikWeb estará disponível.

https://api.mikweb.com.br/v1/admin/

Autenticação

Exemplo:

curl "https://api.mikweb.com.br/v1/admin/customers" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

Subistitua <seu-token> com seu Token.

A autenticação na API MikWeb é feita usando o padrão Token Autentication. RFC 6750

Se você deseja gerar um Token de autenticação, basta acessar o menu Sistema > API, ou siga este passo a passo.

Para realizar uma requisição basta enviar o Token no cabeçalho da requisição.

Authorization: Bearer seu-token

Substitua seu-token por um Token válido.

Todas as requisições devem ser enviadas com o HEADER contendo a chave valor Content-Type: application/json

Clientes

Cadastrando um Cliente

Requisição de Cadastro

curl "https://api.mikweb.com.br/v1/admin/customers" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{
        \"full_name\": \"MikWeb\",
        \"login\": \"mikweb\",
        \"password\": \"tivia\",
        \"due_day\": 1,
        \"server_id\": 1,
        \"plan_id\": 1
      }"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "customer": {
        "id": 2,
        "server_id": 1,
        "plan_id": 1,
        "customer_group_id": 1,
        "full_name": "MikWeb",
        "login": "mikweb",
        "password": "tivia",
        "email": "mikweb@mikweb.com",
        "authentication_type": "pppoe",
        "person_type": "Física",
        "cpf_cnpj": "32286450021",
        "due_day": 1,
        "phone_number": "1187654321",
        "cell_phone_number_1": "11912345678",
        "financial_status": "L",
        "msg_payment_mk": "L",
        "allow_password_change": true,
        "automatic_monthly": true,
        "automatic_lock_message": true,
        "automatic_pendency_message": true,
        "subscriber_type": "3",
        "utilization_type": "4",
        "free_monthly": false,
        "status": "Ativo",
        "server": {
            "id": 1,
            "name": "CORE B",
            "hash_server": "865F674C036F8655C9D3A8A657858C72"
        },
        "plan": {
            "id": 1,
            "name": "100 MB",
            "value": "50.0"
        },
        "customer_group": {
            "id": 1,
            "name": "FIBRA"
        }
    }
}

POST https://api.mikweb.com.br/v1/admin/customers

Este endpoint cadastra um cliente de acordo com os parâmetros passados.

Parâmetros que podem ser urtilizados para cadastrar/atualizar um cliente

Parâmerto	Tipo	Descrição	Validações
`full_name` *	string	Nome completo do cliente.	Max: 255
`login` *	string	Login do cliente que será usado para a autenticação no Mikrotik.	Letras, números, espaço, "_", "." e "-", único na conta, Max: 60
`password`	string	Senha do cliente que será usado para a autenticação no Mikrotik.	Letras, números, espaço, "_", "." e "-", Max: 60
`email`	string	Email do cliente.	Apenas Emails válidos, Max: 60
`birth_date`	date	Data de nascimento do cliente.	dd-MM-yyyy
`due_day` *	integer	Dia de vencimento do cliente, que será usado no processo de emissão de cobranças.	De 1 a 31.
`person_type`	string	Tipo de Cadastro de Pessoa.	Apenas "Física" ou "Jurídica"
`cpf_cnpj`	string	CPF ou CNPJ de acordo com o person_type.	Apenas números [11..14]
`rg`	string	Registro Geral para person_type="Física".	Apenas números
`state_registration`	string	Inscrição Estadual para person_type="Jurídica".	Apenas números
`phone_number`	string	Número para contato residencial com DDD.	DDD + Número
`cell_phone_number_1`	string	Celular para contato com DDD.	DDD + Número
`cell_phone_number_2`	string	Celular para contato com DDD.	DDD + Número
`cell_phone_number_3`	string	Celular para contato com DDD.	DDD + Número
`cell_phone_number_4`	string	Celular para contato com DDD.	DDD + Número
`zip_code`	string	CEP.	Apenas números com 8 dígitos
`street`	string	Rua ou Logradouro.
`number`	string	Número do endereço.
`complement`	string	Complemento ou ponto de referencia.
`neighborhood`	string	Bairro.	Max: 60
`city`	string	Cidade.	Max: 60
`state`	string	UF do estado.
`customer_since`	date	Data de adesão ou Cliente desde.	dd-MM-yyyy
`authentication_type`	string	Tipo de autenticação no servidor Mikrotik.	"pppoe", "hotspot" ou "hotspot,pppoe", Padrão "pppoe"
`ip`	string	Ip estático para o tipo de autenticação HotSpot.	De 0.0.0.0 a 255.255.255.255
`ip_pppoe`	string	Ip estático para o tipo de autenticação PPPoE.	De 0.0.0.0 a 255.255.255.255
`mac`	string	MAC para controle de dispositivo na autenticação.	De 00:00:00:00:00:00 a FF:FF:FF:FF:FF:FF
`subscriber_type`	string	Tipo de Assinante -- Referente a emissão de NFe.	Padrão "3" Residencial Pessoa Física
`utilization_type`	string	Tipo de Utilização -- Referente a emissão de NFe.	Padrão "4" Provimento de acesso à Internet
`allow_password_change`	boolean	Autoriza o cliente a atualizar a senha/password através da Central do Cliente.	Padrão true
`monthly_discount`	float	Desconto na Mensalidade (R$) -- Valor que será reduzido no valor da cobrança.	Não pode ser maior que o valor do Plano
`monthly_increase`	float	Acréscimo na Mensalidade (R$) -- Valor que será acrescentado no valor da cobrança.	Ponto/Virgula flutuante com dois dígitos de precisão
`automatic_monthly`	boolean	Mensalidade automática -- Permite o controle individual do cliente para emissão de cobranças automática.	Padrão true
`automatic_lock_message`	boolean	Mensagem de Bloqueio Automática -- Controle para ativação da mensagem de Bloqueio automática.	Padrão true
`automatic_pendency_message`	boolean	Mensagem de Pendência Automática -- Controle para ativação da mensagem de Pendência automática.	Padrão true
`days_to_pendency`	integer	Dias para msg. Pendência -- Quantidade de dias em atraso para a ativação da mensagem de Pendência.	Números positivos
`days_to_lock`	integer	Dias para msg. Bloqueio -- Quantidade de dias em atraso para a ativação da mensagem de Bloqueio.	Números positivos
`free_monthly`	boolean	Isento mensalidade -- Para clientes que não pagam mensalidade.	Padrão false
`status`	string	Status do cadastro do cliente.	"Ativo" ou "Desativado", Padrão "Ativo"
`server_id` *	integer	ID do servidor onde o cliente autenticará.
`plan_id` *	integer	ID do plano para controle de banda do cliente. O mesmo deve está associado ao Servidor do cliente.
`customer_group_id`	integer	ID do Grupo de Clientes -- Pode ser usado para facilitar gestão.
`observation`	string	Observações referentes ao cliente.	Max: 255
`pre_registrate`	boolean	Controle para cadastro de clientes potencial/leads.	Padrão false

Os parâmetros marcados com asterisco * são obrigatorios!

Consultando um Cliente

Requisição de Consulta

curl "https://api.mikweb.com.br/v1/admin/customers/2" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "customer": {
        "id": 2,
        "server_id": 1,
        "plan_id": 1,
        "customer_group_id": 1,
        "full_name": "MikWeb",
        "login": "mikweb",
        "password": "tivia",
        "email": "mikweb@mikweb.com",
        "authentication_type": "pppoe",
        "person_type": "Física",
        "cpf_cnpj": "32286450021",
        "due_day": 1,
        "phone_number": "1187654321",
        "cell_phone_number_1": "11912345678",
        "financial_status": "L",
        "msg_payment_mk": "L",
        "allow_password_change": true,
        "automatic_monthly": true,
        "automatic_lock_message": true,
        "automatic_pendency_message": true,
        "subscriber_type": "3",
        "utilization_type": "4",
        "free_monthly": false,
        "status": "Ativo",
        "server": {
            "id": 1,
            "name": "CORE B",
            "hash_server": "865F674C036F8655C9D3A8A657858C72"
        },
        "plan": {
            "id": 1,
            "name": "100 MB",
            "value": "50.0"
        },
        "customer_group": {
            "id": 1,
            "name": "FIBRA"
        }
    }
}

GET https://api.mikweb.com.br/v1/admin/customers/<ID>

Este endpoint retorna um Cliente especifico. Que será identificado através do <ID>.

Substitua ID por um ID válido.

Atualizando um Cliente

Requisição de Atualização

curl "https://api.mikweb.com.br/v1/admin/customers/2"  \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{
        \"full_name\": \"MikWeb Sistema de Gestão de Provedores\",
        \"observation\": \"informações adicionais relevantes.\"
      }"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "customer": {
        "id": 2,
        ...
        "full_name": "MikWeb Sistema de Gestão de Provedores",
        ...
        "observation": "informações adicionais relevantes.",
        ...
    }
}

PUT https://api.mikweb.com.br/v1/admin/customers/<ID>

Este endpoint atualizará um Cliente especifico. Que será identificado através do <ID>.

Substitua ID por um ID válido.

Desconectando um Cliente

curl "https://api.mikweb.com.br/v1/admin/customers/2/logout" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "customer": {...}
}

POST https://api.mikweb.com.br/v1/admin/customers/<ID>/logout

Este endpoint derrubara a conexão do Cliente caso esteja Online. O Cliente será identificado através do <ID> passado na URI.

Substitua ID por um ID válido.

Alterando o Status de um Cliente

Requisição de Atualização de Status

curl "https://api.mikweb.com.br/v1/admin/customers/2/status" \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{\"status\": \"Desativado\"}"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "customer": {
      "id": 2,
      ...
      "status": "Desativado",
      ...
    }
}

PUT https://api.mikweb.com.br/v1/admin/customers/<ID>/status

Este endpoint atualizará o status de um Cliente especifico. Que será identificado através do <ID>.

Opções para o parâmetro `status`

Opções	Descrição
`Ativo`	Altera o status do cliente para Ativo, permitindo a autenticação no Servidor.
`Desativado`	Altera o status do cliente para Desativado, bloqueando a autenticação no Servidor.

Substitua ID por um ID válido.

Alterando o Status de Acesso de um Cliente

Requisição de Atualização de Status de Acesso

curl "https://api.mikweb.com.br/v1/admin/customers/2/msg_payment" \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{\"msg_payment_mk\": \"P\"}"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "customer": {
      "id": 2,
      ...
      "msg_payment_mk": "P",
      ...
    }
}

PUT https://api.mikweb.com.br/v1/admin/customers/<ID>/msg_payment

Este endpoint atualizará o status de acesso de um Cliente especifico. Que será identificado através do <ID>.

Opções para o parâmetro `msg_payment_mk`

Opções	Descrição
`L`	Altera o status de acesso do cliente para Liberado, liberando a navegação.
`P`	Altera o status de acesso do cliente para Pendente, redirecionando o trafego para a mensagem de pendencia.
`B`	Altera o status de acesso do cliente para Bloqueado, redirecionando o trafego para a mensagem de bloqueio.

Substitua ID por um ID válido.

Listando Clientes

Requisição de Listagem

curl "https://api.mikweb.com.br/v1/admin/customers" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "customers": [...],
    "meta": {
        "pages": {
            "current_page": 1,
            "next_page": 2,
            "prev_page": null,
            "total_pages": 95,
            "total_count": 1898
        },
        "statistics": false
    }
}

GET https://api.mikweb.com.br/v1/admin/customers

Este endpoint retorna uma listagem de clientes.

Parâmetros que podem ser usados para filtrar clientes

Parâmerto	Tipo	Descrição	Opções
`customer_group_id`	integer	Filtra os clientes por Grupo de Clientes.
`server_id`	integer	Filtra os clientes por Servidor.
`plan_id`	integer	Filtra os clientes por Plano.
`msg_payment_mk`	string	Filtra os clientes com o status de acesso correspondente. Ex. L para Liberados.	"P", "M" ou "L"
`status`	string	Filtra os clientes com o status correspondente.	"Ativo" ou "Desativado"
`free_monthly`	boolean	Filtra os clientes isentos.
`pre_registrate`	boolean	Filtra os Pré-Cadastros de clientes.	Padrão false
`due_day`	integer	Filtra os clientes com o dia de vencimento correspondente.
`person_type`	string	Filtra os clientes de acordo com o tipo de Cadastro de Pessoa.	"Física" ou "Jurídica"
`per_page`	integer	Define a quantidade de clientes retornado na listagem.	Padrão 20, minimo 1 e máximo 250
`page`	integer	Parâmetro dedicado a paginação.
`include`	string	Inclui metadados referentes a consulta.	"statistics"

Requisição de Pesquisa

curl "https://api.mikweb.com.br/v1/admin/customers?search=luiz" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

Campos disponíveis para pesquisa

Todas as opções abaixo devem ser passadas como valor para o parâmetro search, para que a pesquisa funcione como desejado.

Opções	Descrição
`full_name`	Nome Completo do Cliente, pode ser informado de forma parcial.
`login`	Login do Cliente, pode ser informado de forma parcial.
`phone_number`	Número para contato residencial com DDD, pode ser informado de forma parcial.
`cpf_cnpj`	CPF ou CNPJ do Clinete, com apenas números e pode ser informado de forma parcial.
`rg`	Registro Geral do Cliente, pode ser informado de forma parcial.
`neighborhood`	Bairro do endereço do Cliente, pode ser informado de forma parcial.
`street`	Rua do endereço do Cliente, pode ser informado de forma parcial.

Deletando um Cliente

Requisição para Deletar

curl "https://api.mikweb.com.br/v1/admin/customers/1" \
  -X DELETE \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

DELETE DELETE https://api.mikweb.com.br/v1/admin/customers/<ID>

Este endpoint exclui um Cliente especifico. Que será identificado através do <ID>.

O comando acima retorna apenas o status code: 204, quando executado com sucesso.

Cobranças

Cadastrando uma Cobrança

Requisição de Cadastro

curl "https://api.mikweb.com.br/v1/admin/billings" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{
        \"customer_id\": 2,
        \"due_day\": \"2020-05-29\",
        \"reference\": \"Mensalidade de acesso à Internetz\",
        \"situation_id\": \"1\",
        \"type_billing\": \"M\",
        \"value\": 200
     }"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "billing": {
        "id": 2,
        "customer_id": 2,
        "value": 200.0,
        "value_paid": null,
        "date_payment": null,
        "situation_id": 1,
        "reference": "Mensalidade de acesso à Internet",
        "type_billing": "M",
        "due_day": "2020-05-29",
        "observation": null,
        "cod_classification": "104",
        "form_payment": "n",
        "situation_name": "Em Aberto",
        "customer": {
            "id": 2,
            "full_name": "MikWeb"
        },
        "situation": {
            "id": 1,
            "name": "Em Aberto"
        }
    }
}

POST https://api.mikweb.com.br/v1/admin/billings

Este endpoint cadastra uma cobrança de acordo com os parâmetros passados.

Parâmetros que podem ser urtilizados para cadastrar/atualizar uma Cobrança

Parâmerto	Tipo	Descrição	Validações
`customer_id` *	integer	Identificador Unico (ID) do cliente para qual a cobrança será gerada.
`due_day` *	date	Data de vencimento da cobrança.	dd-MM-yyyy
`reference` *	string	Referencia -- Mensagem referente ao produto/serviço origem da cobrança.	Max: 255
`situation_id` *	integer	Identificador Unico (ID) da situação da cobrança.	Veja a documentação de Situações
`type_billing` *	string	Tipo da cobraça	"M" para Mensalidade de Internet e "A" para Avulsa
`value` *	float	Valor total em R$	Ponto/Virgula flutuante com dois dígitos de precisão
`value_paid`	float	Valor pago em R$	Ponto/Virgula flutuante com dois dígitos de precisão
`date_payment`	date	Data de pagamento da cobrança.	dd-MM-yyyy
`observation`	text	Observações adicionais para controle interno.
`cod_classification`	string	Código de Classificação -- Referente a emissão de NFe.	Padrão "104"
`payment_place`	string	Descrição do local de pagamento.	Max: 255

Os parâmetros marcados com asterisco * são obrigatorios!

Parâmetros apenas leitura de uma Cobrança

Parâmerto	Tipo	Descrição	Validações
`situation_name`	string	Descrição da Situação da Cobrança.	Veja a documentação de Situações
`number_payment`	integer	Número da cobrança associada ao Cliente.
`lock_in`	date	Data do final da Observação/Liberação em Confiança.	dd-MM-yyyy
`form_payment`	string	Forma de emissão da cobrançaa.	Veja a documentação de Formas de Cobranças
`status_send`	integer	Situação do envio da cobrança em relação a Forma de Emissão (Apenas Gateways).	1 para sucesso e 2 para erro no envio
`status_message`	string	Mensagem com destrição do `status_send`.
`integration_link`	string	Link para a cobrança no Gateway de Cobrança.
`digitable_line`	string	Código de Barras/Linha Digitavel da cobrança.
`payment_card_id`	integer	Identificador Unico (ID) do do Carnê (Caso a Cobrança pertença a um Carnê).
`parcel_number`	integer	Número da Cobranaça/Parcela associada ao Carnê.
`bank_account_id`	integer	Identificador Unico (ID) do do Carnê (Caso a Cobrança pertença a um Carnê).
`number_billet`	integer	Número da Cobranaça/Nosso nùmero associada a Conta bancaria.
`our_number`	integer	Número da Cobranaça/Nosso nùmero associada a Conta bancaria.
`generated_shipping`	boolean	Situação da Cobrança em relação ao Arquivo de Remessa.	Padrão false
`date_shipping`	date	Data de criação do Arquivo de Remessa.	dd-MM-yyyy
`type_shipping`	string	Tipo do arquivo de remessa.	"Baixa" ou "Remessa"
`nf_issued`	boolean	Situação da cobrança em relação a emissão de NFe.
`nf_issue_date`	date	Data de emissão da NFe.	dd-MM-yyyy

Consultando uma Cobrança

Requisição de Consulta

curl "https://api.mikweb.com.br/v1/admin/billings/2" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "billing": {
        "id": 2,
        "customer_id": 2,
        "value": 200.0,
        "value_paid": null,
        "date_payment": null,
        "situation_id": 1,
        "reference": "Mensalidade de acesso à Internet",
        "type_billing": "M",
        "due_day": "2020-05-29",
        "observation": null,
        "cod_classification": "104",
        "form_payment": "n",
        "situation_name": "Em Aberto",
        "customer": {
            "id": 2,
            "full_name": "MikWeb"
        },
        "situation": {
            "id": 1,
            "name": "Em Aberto"
        }
    }
}

GET https://api.mikweb.com.br/v1/admin/billings/<ID>

Este endpoint retorna uma Cobrança especifica. Que será identificada através do <ID>.

Substitua ID por um ID válido.

Os valores das chaves pix_copy_paste_base64 e pix_qr_code_image_base64 só estão disponíveis em cobranças emitidas através de uma Conta de Pagamento.

Atualizando uma Cobrança

Requisição de Atualização

curl "https://api.mikweb.com.br/v1/admin/billings/2"  \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{
        \"situation_id\": 3,
        \"value_paid\": 200,
        \"date_payment\": \"13-05-2020\"
      }"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "billing": {
        "id": 2,
        "customer_id": 2,
        "value": 200.0,
        "value_paid": 200.0,
        "date_payment": "2020-05-13",
        "situation_id": 3,
        "reference": "Mensalidade de acesso à Internet",
        "type_billing": "M",
        "due_day": "2020-05-29",
        "observation": null,
        "cod_classification": "104",
        "form_payment": "n",
        "situation_name": "Efetuado",
        "customer": {
            "id": 2,
            "full_name": "MikWeb"
        },
        "situation": {
            "id": 3,
            "name": "Efetuado"
        }
    }
}

PUT https://api.mikweb.com.br/v1/admin/billings/<ID>

Este endpoint atualizará uma Cobrança especifico. Que será identificado através do <ID>.

Substitua ID por um ID válido.

Deletando uma Cobrança

Requisição para Deletar

curl "https://api.mikweb.com.br/v1/admin/billings/1" \
  -X DELETE \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

DELETE DELETE https://api.mikweb.com.br/v1/admin/billings/<ID>

Este endpoint exclui uma Cobrança especifica. Que será identificado através do <ID>.

O comando acima retorna apenas o status code: 204, quando executado com sucesso.

Confirmando uma Cobrança

Requisição de Atualização

curl "https://api.mikweb.com.br/v1/admin/billings/<ID>/confirm"  \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{
        \"date_payment\": \"26-05-2020\",
        \"value_paid\": 20.0
      }"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "billing": {
        "value": 20.0,
        "value_paid": 20.0,
        "situation_id": 3,
        "date_payment": "2020-05-26",
        "situation_name": "Efetuado",

        ...

        "situation": {
            "id": 3,
            "name": "Efetuado"
        }
    }
}

PUT https://api.mikweb.com.br/v1/admin/billings/<ID>/confirm

Este endpoint altera o status da Cobranças para Efetuado. A Cobrança será identificado através do <ID>.

Parâmetros para confirmação

Parâmerto	Tipo	Descrição	Opções
`date_payment`	date	Data de pagamento da cobrança, no formato dd-MM-yyyy.	Padrão due_day
`value_paid`	float	Valor pago, Ponto/Virgula flutuante com dois dígitos de precisão	Padrão value

Substitua ID por um ID válido.

Colocando em Observação

Requisição de Atualização

curl "https://api.mikweb.com.br/v1/admin/billings/<ID>/add_observation"  \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{ \"lock_in\": \"27-05-2021\" }"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "billing": {
        "id": 2,
        "situation_id": 4,
        "lock_in": "2021-05-27",
        "situation_name": "Em Observação",

        ...

        "situation": {
            "id": 4,
            "name": "Em Observação"
        }
    }
}

PUT https://api.mikweb.com.br/v1/admin/billings/<ID>/add_observation

Este endpoint altera o status da Cobranças para Em Observação. A Cobrança será identificado através do <ID>.

Quando a cobrança está em Observação não são aplicadas as politicas de cobranças que levariam o cliente ao bloqueio por atraso. Esse recurso é muito utilizado para o processo de liberação em confiança.

O parâmetro lock_in define a data de fim da observação e não é obrigatório, porém caso o mesmo seja null, branco ou menor que a data atual, a cobrança será colocada em observação por tempo indeterminando.

Parâmerto	Descrição
`lock_in`	Data de fim da observação, no formato dd-MM-yyyy.

Substitua ID por um ID válido.

Removendo a Observação

Requisição de Atualização

curl "https://api.mikweb.com.br/v1/admin/billings/<ID>/remove_observation"  \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "billing": {
        "situation_id": 1,
        "due_day": "2020-05-29",
        "lock_in": null,
        "situation_name": "Em Aberto",

        ...

        "situation": {
            "id": 1,
            "name": "Em Aberto"
        }
    }
}

PUT https://api.mikweb.com.br/v1/admin/billings/<ID>/remove_observation

Este endpoint remove o status da Cobranças de Em Observação. A Cobrança será identificado através do <ID>.

Ao remover a Observação o Status da Cobrança será atualizado automaticamente e a politica de cobranças será aplicada.

Substitua ID por um ID válido.

Listando Cobranças

Requisição de Listagem

curl "https://api.mikweb.com.br/v1/admin/billings" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "billings": [...],
    "meta": {
        "pages": {
            "current_page": 1,
            "next_page": 2,
            "prev_page": null,
            "total_pages": 95,
            "total_count": 1898
        },
        "statistics": false
    }
}

GET https://api.mikweb.com.br/v1/admin/billings

Este endpoint retorna uma listagem de cobranças.

Parâmetros que podem ser usados para filtrar cobranças

Parâmerto	Tipo	Descrição	Opções
`situation_id`	integer	Filtra as cobranças por Situação.	Veja a documentação de Situações
`customer_id`	integer	Filtra as cobranças por Clientes.
`payment_card_id`	integer	Filtra as cobranças por Carnê.
`customer_group_id`	integer	Filtra as cobranças por Grupo de Clientes.
`generated_shipping`	boolean	Filtra as cobranças por situação do Arquivo de Remessa.
`type_shipping`	string	Filtra as cobranças por tipo do Arquivo de Remessa.	"Baixa" ou "Remessa"
`nf_issued`	boolean	Filtra as cobranças por situação da emissão da NFe.
`payment_place`	string	Filtra as cobranças por local de pagamento.
`form_payment`	string	Filtra as cobranças por forma de emissão.	Veja a documentação de Formas de Cobranças
`per_page`	integer	Define a quantidade de clientes retornado na listagem.	Padrão 20, minimo 1 e máximo 250
`page`	integer	Parâmetro dedicado a paginação.
`include`	string	Inclui metadados referentes a consulta.	"statistics"

Requisição de Pesquisa

curl "https://api.mikweb.com.br/v1/admin/billings?search=luiz" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

Campos disponíveis para pesquisa

Todas as opções abaixo devem ser passadas como valor para o parâmetro search, para que a pesquisa funcione como desejado.

Opções	Descrição
`login`	Login do Cliente, pode ser informado de forma parcial.
`full_name`	Nome Completo do Cliente, pode ser informado de forma parcial.

Requisição de Listagem com filtro de Data

curl "https://api.mikweb.com.br/v1/admin/billings?type_date=due_day&start_date=01-05-2020&end_date=01-05-2020" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

Opções de filtro por data

Todas as opções abaixo devem ser passadas como valor para o parâmetro type_date, para que o filtro de período funcione como desejado.

Parâmerto	Descrição
`due_day`	Data de vencimento da cobrança.
`date_payment`	Data de pagamento da cobrança.
`lock_in`	Data do final da Observação/Liberação em Confiança.
`nf_issue_date`	Data de emissão da NFe.
`created_at`	Data de criação da cobrança.
`updated_at`	Data da ultima atualização da cobrança.

Para que os filtros de data funcionem corretamente devem ser usados juntamente com os parâmetros start_date e end_date no formato dd-MM-yyyy

Requisição de Listagem ordenada por Dia de Vencimento em ordem Decrescente

curl "https://api.mikweb.com.br/v1/admin/billings?sort_field=due_day&sort_direction=desc" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

Opções de Ordenação

As opções abaixo podem ser passadas como valor para o parâmetro sort_field, de forma a ordenar a listagem retornada como desejado.

Parâmerto	Descrição
`id`	ID da cobrança.
`due_day`	Data de vencimento da cobrança.
`date_payment`	Data de pagamento da cobrança.
`lock_in`	Data do final da Observação/Liberação em Confiança.
`nf_issue_date`	Data de emissão da NFe.
`created_at`	Data de criação da cobrança.
`updated_at`	Data da ultima atualização da cobrança.
`situation_id`	ID do Situação da Cobrança.
`customer_id`	ID do Cliente.
`customer_group_id`	ID do Grupo dos Clientes.
`value`	Valor da Cobrança.
`value_paid`	Valor Pago da Cobrança.
`payment_card_id`	ID do Carnê.
`number_billet`	Número do Boleto para Boletos registrados.

O sentido da ordenação pode ser alterado passando parâmetro sort_direction com o valor desc ou asc.

Por padrão é considerado o valor due_day para o parâmetro sort_field e asc para sort_direction.

Download de uma Cobrança

Requisição de Consulta.

curl "https://api.mikweb.com.br/v1/admin/billings/<ID>/download?valid=true" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -o "<ID>.pdf"

O comando acima deverá retornar um arquivo PDF.

GET https://api.mikweb.com.br/v1/admin/billings/<ID>/download?valid=true

Este endpoint retorna um PDF da cobrança especifica. Que será identificada através do <ID>.

Substitua ID por um ID válido.

Este recurso está disponível apenas para cobranças com o parâmetro form_payment igual a "br". Veja a documentação de Formas de Cobranças

Link PagSeguro

Requisição de Consulta

curl "https://api.mikweb.com.br/v1/admin/billings/<ID>/pagseguro" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "payment_url": "https://pagseguro.uol.com.br/..."
}

GET https://api.mikweb.com.br/v1/admin/billings/<ID>/pagseguro

Este endpoint retorna o link para a Cobrança no PagSeguro. A Cobrança será identificada através do <ID>.

Substitua ID por um ID válido.

Este recurso está disponível apenas para cobranças com o parâmetro form_payment igual a "ps". Veja a documentação de Formas de Cobranças

Situações das Cobranças

Situações possíveis de uma Cobrança

ID	Nome	Descrição
`1`	Em Aberto	Situação de cobranças que ainda não foram pagas e a data de pagamento ainda não passou.
`2`	Em Atraso	Situação de cobranças que ainda não foi paga, mas a data de pagamento já passou.
`3`	Efetuado	Situação de cobranças que já foram pagas.
`4`	Em Observação	Situação que anula o efeito de bloqueio para o cliente que esteja em atraso.

Formas de Cobrança

As formas de cobranças podem ser confirugaras no menu Sistema > Confiruações na aba Cobranças.

Formas de cobranças disponíveis no MikWeb

Identificador	Nome	Descrição
`n`	Nenhum	Caso não haja nenhuma forma de cobrança configurada.
`ci`	Carnê Informal	Cobrança gerada pelos sistema MikWeb sem vinculação bancaria, no formato de Carnê.
`br`	Boleto Registrado	Cobrança gerada pelos sistema MikWeb com vinculação bancaria. Carnês ou Boletos
`bf`	Boleto Fácil	Gateway de cobranças que trabalha tanto com Boletos como com Carnês.
`gn`	GerenciaNet	Gateway de cobranças que trabalha tanto com Boletos como com Carnês.
`cgn`	GerenciaNet	Gateway de cobranças que trabalha tanto com Boletos como com Carnês (Depreciado).
`f2b`	F2B	Gateway de cobranças que trabalha tanto com Boletos como com Carnês.
`gp`	GalaxPay	Gateway de cobranças que trabalha tanto com Boletos como com Carnês.
`ps`	PagSeguro	Gateway de cobranças que trabalha apenas com Boletos.
`gn_v1`	GerenciaNet	Gateway de cobranças que trabalha tanto com Boletos como com Carnês.
`juno`	Juno	Gateway de cobranças que trabalha tanto com Boletos como com Carnês.

Carnês

Cadastrando um Carnê

Requisição de Cadastro

curl "https://api.mikweb.com.br/v1/admin/payment_cards" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{
        \"customer_id\": 2,
        \"number_installments\": 12,
        \"first_installment_date\": \"13-06-2020\",
        \"type_billing\": \"M\"
     }"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "payment_card": {
        "id": 1,
        "type_billing": "M",
        "reference": "Mensalidade de Acesso à Internet",
        "number_installments": 12,
        "still_have_to_pay": 12,
        "filed": false,
        "status": "N",
        "registered": false,
        "first_installment_date": "2020-06-13",
        "value": null,
        "status_send": null,
        "status_message": null,
        "link": null,
        "form_payment": "ci",
        "created_at": "2020-05-29T15:46:45.000Z",
        "updated_at": "2020-05-29T15:46:45.000Z",
        "customer_id": 2,
        "date_shipping": null,
        "type_shipping": null,
        "generated_shipping": false,
        "customer": {
            "id": 2,
            "full_name": "MikWeb",
            "plan": {
                "id": 1,
                "name": "1 Mbp/s - Basic",
                "value": "10.0"
            }
        }
    }
}

POST https://api.mikweb.com.br/v1/admin/payment_cards

Este endpoint cadastra um Carnê de acordo com os parâmetros passados.

Parâmetros que podem ser urtilizados para cadastrar um Carnê

Parâmerto	Tipo	Descrição	Validações
`customer_id` *	integer	Identificador Único (ID) do cliente para qual o Carnê será gerado.
`first_installment_date` *	date	Data de vencimento da primeira cobrança.	dd-MM-yyyy
`number_installments` *	integer	Número de parcelas que o Carnê terá.	Min: 1 Max: 12
`type_billing` *	string	Tipo do Carnê	"M" para Mensalidade de Internet e "A" para Avulsa
`value`	float	Valor total do Carnê em R$	Ponto/Virgula flutuante com dois dígitos de precisão
`reference`	string	Referencia -- Mensagem referente ao produto/serviço origem da cobrança.	Max: 255

Os parâmetros marcados com asterisco * são obrigatórios!

Os parâmetros value e reference são obrigatórios se type_billing for igual a "A".

O parâmetro value é o valor total de todas as parcelas do Carnê se type_billing for igual a "A".

O parâmetro value será preenchido automaticamente com o valor do Plano se type_billing for igual a "M".

O parâmetro reference será preenchido automaticamente com "Mensalidade de Acesso à Internet" se type_billing for igual a "M".

Parâmetros apenas leitura de uma Cobrança

Parâmerto	Tipo	Descrição	Validações
`still_have_to_pay`	integer	Número de parcelas em aberto.
`filed`	boolean	True para Carnês arquivados.
`status`	string	Status do Carnê.	Veja a documentação de Status de Carnês
`form_payment`	string	Forma de emissão do Carnê.	Veja a documentação de Formas de Cobranças
`registered`	boolean	True para Carnês com `form_payment` igual a "br".
`status_send`	integer	Situação do envio da cobrança em relação a Forma de Emissão (Apenas Gateways).	1 para sucesso e 2 para erro no envio
`status_message`	string	Mensagem com descrição do `status_send`.
`link`	string	Link para o Carnê no Gateway de Cobrança.
`digitable_line`	string	Código de Barras/Linha Digitável da cobrança.
`parcel_number`	integer	Número de Cobranças/Parcelas associada ao Carnê.
`generated_shipping`	boolean	Situação da Cobrança em relação ao Arquivo de Remessa.	Padrão false
`date_shipping`	date	Data de criação do Arquivo de Remessa.	dd-MM-yyyy
`type_shipping`	string	Tipo do arquivo de remessa.	"Baixa" ou "Remessa"
`created_at`	date	Data de criação do Carnê.	dd-MM-yyyy
`updated_at`	date	Data de atualização do Carnê.	dd-MM-yyyy

Consultando um Carnê

Requisição de Consulta

curl "https://api.mikweb.com.br/v1/admin/payment_cards/2" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "payment_card": {
        "id": 1,
        "type_billing": "M",
        "reference": "Mensalidade de Acesso à Internet",
        "number_installments": 12,
        "still_have_to_pay": 12,
        "filed": false,
        "status": "N",
        "registered": false,
        "first_installment_date": "2020-06-13",
        "value": null,
        "status_send": null,
        "status_message": null,
        "link": null,
        "form_payment": "ci",
        "created_at": "2020-05-29T15:46:45.000Z",
        "updated_at": "2020-05-29T15:46:45.000Z",
        "customer_id": 2,
        "date_shipping": null,
        "type_shipping": null,
        "generated_shipping": false,
        "customer": {
            "id": 2,
            "full_name": "MikWeb",
            "plan": {
                "id": 1,
                "name": "1 Mbp/s - Basic",
                "value": "10.0"
            }
        }
    }
}

GET https://api.mikweb.com.br/v1/admin/payment_cards/<ID>

Este endpoint retorna um Carnê especifico. Que será identificada através do <ID>.

Substitua ID por um ID válido.

Download de um Carnê

Requisição de Consulta.

curl "https://api.mikweb.com.br/v1/admin/payment_cards/<ID>/generate_blades?valid=true" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -o "<ID>.pdf"

O comando acima deverá retornar um arquivo PDF.

GET https://api.mikweb.com.br/v1/admin/payment_cards/<ID>/generate_blades?valid=true

Este endpoint retorna um PDF do Carnê especifico. Que será identificada através do <ID>.

Substitua ID por um ID válido.

Este recurso está disponível apenas para Carnês com o parâmetro form_payment igual a "br". Veja a documentação de Formas de Cobranças

Listando Carnês

Requisição de Listagem

curl "https://api.mikweb.com.br/v1/admin/payment_cards" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "payment_cards": [...],
    "meta": {
        "pages": {
            "current_page": 1,
            "next_page": 2,
            "prev_page": null,
            "total_pages": 2,
            "total_count": 30
        },
        "statistics": false
    }
}

GET https://api.mikweb.com.br/v1/admin/payment_cards

Este endpoint retorna uma listagem de Carnês.

Parâmetros que podem ser usados para filtrar carnês

Parâmerto	Tipo	Descrição	Opções
`customer_id`	integer	Filtra as Carnês por Clientes.
`status`	string	Filtra as Carnês por Status.	Veja a documentação de Status de Carnês
`filed`	boolean	Filtra as Carnês Arquivados.	Padrão false
`form_payment`	string	Filtra as cobranças por forma de emissão.	Veja a documentação de Formas de Cobranças
`generated_shipping`	boolean	Filtra as Carnês de acordo com a situação do Arquivo de Remessa.	Apenas para `form_payment` = "br"

Requisição de Pesquisa

curl "https://api.mikweb.com.br/v1/admin/payment_cards?search=MikWeb" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

Campos disponíveis para pesquisa

Todas as opções abaixo devem ser passadas como valor para o parâmetro search, para que a pesquisa funcione como desejado.

Opções	Descrição
`id`	Identificador Único do Cliente.
`full_name`	Nome Completo do Cliente, pode ser informado de forma parcial.

Requisição de Listagem com filtro de Data

curl "https://api.mikweb.com.br/v1/admin/payment_cards?type_date=due_day&start_date=01-05-2020&end_date=01-05-2020" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

Opções de filtro por data

Todas as opções abaixo devem ser passadas como valor para o parâmetro type_date, para que o filtro de período funcione como desejado.

Parâmetro	Descrição
`created_at`	Data de criação do Carnê.

Para que os filtros de data funcionem corretamente devem ser usados juntamente com os parâmetros start_date e end_date no formato dd-MM-yyyy

Deletando um Carnê

Requisição para Deletar

curl "https://api.mikweb.com.br/v1/admin/payment_cards/1" \
  -X DELETE \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

DELETE DELETE https://api.mikweb.com.br/v1/admin/payment_cards/<ID>

Este endpoint exclui um Carnê especifico. Que será identificado através do <ID>.

O comando acima retorna apenas o status code: 204, quando executado com sucesso.

Arquivando um Carnê

Requisição de Atualização

curl "https://api.mikweb.com.br/v1/admin/payment_cards/<ID>/filed"  \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima deverá retornar um objeto JSON similar ao abaixo:

{
    "payment_card": {
        "id": 2,
        "filed": true,
        "value": null,
        ...
    }
}

PUT https://api.mikweb.com.br/v1/admin/payment_cards/<ID>/filed

Este endpoint arquivará um Carnê. Que será identificado através do <ID>.

Substitua ID por um ID válido.

Status de Carnês

Status possíveis de um Carnê

Identificador	Nome	Descrição
`N`	Em Aberto/Novo	Status do Carnê que tenha cobranças em aberto.
`A`	Em Atraso	Status do Carnê que possui alguma cobrança vencida e em aberto.
`C`	Concluido	Status do Carnê que todas as cobranças estão pagas.

Chamados

Cadastrando um Chamado

Requisição de Cadastro

curl "https://api.mikweb.com.br/v1/admin/calledies" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{
        \"subject\": \"Novo cliente\",
        \"message\": \"Realizar a instalação na residencia do cliente.\",
        \"customer_id\": 1,
        \"technical_id\": 1,
        \"called_type_id\": 1,
        \"priority\": \"A\"
     }"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "called": {
        "id": 1,
        "priority": "A",
        "subject": "Novo cliente",
        "message": "Realizar a instalação na residencia do cliente.",
        "registered_by": "MikWeb",
        "modified_by": null,
        "finalized_in": null,
        "status": "0",
        "called_type_id": 1,
        "technical_id": 1,
        "customer_id": 1,
        "finalized_by": null,
        "created_at": "2021-05-21T14:18:47.000Z",
        "updated_at": "2021-05-21T14:18:47.000Z",
        "called_type": {
            "id": 1,
            "description": "Instalação"
        },
        "technical": {
            "id": 1,
            "name": "Paulo Vinicius"
        },
        "customer": {
            "id": 1,
            "full_name": "Luiz Rufino"
        }
    }
}

POST https://api.mikweb.com.br/v1/admin/calledies

Este endpoint cadastrará um chamado de acordo com os parâmetros passados.

Parâmetros que podem ser urtilizados para cadastrar/atualizar um Chamado

Parâmerto	Tipo	Descrição	Validações
`subject` *	string	Breve descrição do chamado	Max: 255
`message` *	text	Descrição detalhada da situação
`customer_id` *	integer	Identificador Unico (ID) do cliente para qual a cobrança será gerada.
`technical_id`	integer	Identificador Unico (ID) de Técnico.	Veja a documentação de Técnicos
`called_type_id`	integer	Identificador Unico (ID) de tipo de chamado.	Veja a documentação de Tipos de Chamados
`priority`	string	Prioridade podendo ser Baixa, Média ou Alta.	B para Baixa, M para Média e A para Alta
`status`	string	Situação do chamado. Ao ser criado estará sempre com o status como Novo	0 para Novo, 1 para Aquardando Cliente, 2 para Aquardando sua Resposta e 4 para Finalizado

Os parâmetros marcados com asterisco * são obrigatorios!

Parâmetros apenas leitura de um Chamado

Parâmerto	Tipo	Descrição	Validações
`id`	integer	Identificador Unico (ID) do Chamado.
`registered_by`	string	Identificação do usuário responsavel pela criação do Chamado.
`modified_by`	string	Identificação do usuário responsavel pela atualização do Chamado.
`finalized_by`	string	Identificação do usuário responsavel pela finalização do Chamado.
`created_at`	date	Data de criação do Chamado.	dd-MM-yyyy
`updated_at`	date	Data de atualização do Chamado.	dd-MM-yyyy
`finalized_in`	date	Data de finalização do Chamado.	dd-MM-yyyy

Consultando um Chamado

Requisição de Consulta

curl "https://api.mikweb.com.br/v1/admin/calledies/1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "called": {
        "id": 1,
        "priority": "A",
        "subject": "Novo cliente",
        "message": "Realizar a instalação na residencia do cliente.",
        "registered_by": "MikWeb",
        "modified_by": null,
        "finalized_in": null,
        "status": "0",
        "called_type_id": 1,
        "technical_id": 1,
        "customer_id": 1,
        "finalized_by": null,
        "created_at": "2021-05-21T14:18:47.000Z",
        "updated_at": "2021-05-21T14:18:47.000Z",
        "called_type": {
            "id": 1,
            "description": "Instalação"
        },
        "technical": {
            "id": 1,
            "name": "Paulo Vinicius"
        },
        "customer": {
            "id": 1,
            "full_name": "Luiz Rufino"
        }
    }
}

GET https://api.mikweb.com.br/v1/admin/calledies/<ID>

Este endpoint retornará um Chamado especifico. Que será identificada através do <ID>.

Substitua ID por um ID válido.

Atualizando um Chamado

Requisição de Atualização

curl "https://api.mikweb.com.br/v1/admin/calledies/1"  \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{
        \"technical_id\": 2,
        \"priority\": \"B\"
      }"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "called": {
        "id": 1,
        "priority": "B",
        "subject": "Novo cliente",
        "message": "Realizar a instalação na residencia do cliente.",
        "registered_by": "MikWeb",
        "modified_by": "MikWeb",
        "finalized_in": null,
        "status": "0",
        "called_type_id": 1,
        "technical_id": 2,
        "customer_id": 1,
        "finalized_by": null,
        "created_at": "2021-05-21T14:44:44.000Z",
        "updated_at": "2021-05-21T18:06:57.000Z",
        "called_type": null,
        "technical": {
            "id": 2,
            "name": "Paulo Vinicius"
        },
        "customer": {
            "id": 1,
            "full_name": "Luiz Rufino"
        }
    }
}

PUT https://api.mikweb.com.br/v1/admin/calledies/<ID>

Este endpoint atualizará um Chamado especifico. Que será identificado através do <ID>.

Substitua ID por um ID válido.

Deletando um Chamado

Requisição para Deletar

curl "https://api.mikweb.com.br/v1/admin/calledies/1" \
  -X DELETE \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

DELETE DELETE https://api.mikweb.com.br/v1/admin/calledies/<ID>

Este endpoint excluirá um Chamado especifico. Que será identificado através do <ID>.

O comando acima retornará apenas o status code: 204, quando executado com sucesso.

Listando Chamados

Requisição de Listagem

curl "https://api.mikweb.com.br/v1/admin/calledies" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "calledies": [...],
    "meta": {
        "pages": {
            "current_page": 1,
            "next_page": null,
            "prev_page": null,
            "total_pages": 1,
            "total_count": 6
        },
        "statistics": false
    }
}

GET https://api.mikweb.com.br/v1/admin/calledies

Este endpoint retornará uma listagem de Chamados.

Parâmetros que podem ser usados para filtrar Chamados

Parâmerto	Tipo	Descrição	Opções
`customer_id`	integer	Filtra os Chamados por Clientes.
`technical_id`	integer	Filtra os Chamados por Técnicos.
`called_type_id`	integer	Filtra os Chamados por Tipos de Chamado.
`status`	string	Situação do chamado.	0 para Novo, 1 para Aquardando Cliente, 2 para Aquardando sua Resposta e 4 para Finalizado
`per_page`	integer	Define a quantidade de clientes retornado na listagem.	Padrão 20, minimo 1 e máximo 250
`page`	integer	Parâmetro dedicado a paginação.
`include`	string	Inclui metadados referentes a consulta.	"statistics"

Requisição de Pesquisa

curl "https://api.mikweb.com.br/v1/admin/calledies?search=luiz" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

Campos disponíveis para pesquisa

Todas as opções abaixo devem ser passadas como valor para o parâmetro search, para que a pesquisa funcione como desejado.

Opções	Descrição
`login`	Login do Cliente, pode ser informado de forma parcial.
`full_name`	Nome Completo do Cliente, pode ser informado de forma parcial.

Requisição de Listagem com filtro de Data

curl "https://api.mikweb.com.br/v1/admin/calledies?type_date=due_day&start_date=01-05-2020&end_date=01-05-2020" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

Opções de filtro por data

Todas as opções abaixo devem ser passadas como valor para o parâmetro type_date, para que o filtro de período funcione como desejado.

Parâmerto	Descrição
`created_at`	Data de criação do Chamado.
`updated_at`	Data da ultima atualização do Chamado.
`finalized_in`	Data da finalização do Chamado.

Para que os filtros de data funcionem corretamente devem ser usados juntamente com os parâmetros start_date e end_date no formato dd-MM-yyyy

Finalizando um Chamado

Requisição de Finalização

curl "https://api.mikweb.com.br/v1/admin/calledies/1/finalize"  \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "called": {
        "id": 1,
        "priority": "B",
        "subject": "Novo cliente",
        "message": "Realizar a instalação na residencia do cliente.",
        "status": "4",
        "called_type_id": 1,
        "technical_id": 1,
        "customer_id": 1,
        "registered_by": "MikWeb",
        "modified_by": "MikWeb",
        "finalized_by": "MikWeb",
        "created_at": "2021-05-21T14:44:44.000Z",
        "updated_at": "2021-05-22T17:51:30.000Z",
        "finalized_in": "2021-05-22T17:51:30.000Z",
        "called_type": null,
        "technical": {
            "id": 1,
            "name": "Paulo Vinicius"
        },
        "customer": {
            "id": 1,
            "full_name": "Luiz Rufino"
        }
    }
}

PUT https://api.mikweb.com.br/v1/admin/calledies/<ID>/finalize

Este endpoint finalizará um Chamado especifico, definindo o status como Finalizado ("4") e também atribuindo o usuário e horario da finalização. O Chamado será identificado através do <ID>.

Substitua ID por um ID válido.

Rastaurando um Chamado

Requisição de Restauração

curl "https://api.mikweb.com.br/v1/admin/calledies/1/restore"  \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "called": {
        "id": 1,
        "priority": "B",
        "subject": "Novo cliente",
        "message": "Realizar a instalação na residencia do cliente.",
        "status": "1",
        "called_type_id": 1,
        "technical_id": 1,
        "customer_id": 1,
        "registered_by": "MikWeb",
        "modified_by": "MikWeb",
        "finalized_by": null,
        "created_at": "2021-05-21T14:44:44.000Z",
        "updated_at": "2021-05-22T17:51:30.000Z",
        "finalized_in": null,
        "called_type": null,
        "technical": {
            "id": 1,
            "name": "Paulo Vinicius"
        },
        "customer": {
            "id": 1,
            "full_name": "Luiz Rufino"
        }
    }
}

PUT https://api.mikweb.com.br/v1/admin/calledies/<ID>/restore

Este endpoint restaurará um Chamado especifico, definindo o status como Aquardando Cliente ("1") e também atribuindo o usuário e horario da finalização como null. O Chamado será identificado através do <ID>.

Substitua ID por um ID válido.

Cadastrando uma Resposta

Requisição de Cadastro

curl "https://api.mikweb.com.br/v1/admin/calledies/1/answer_create" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{\"message\": \"Instalação realizada com sucesso.\"}"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "answer": {
        "id": 1,
        "message": "Instalação realizada com sucesso.",
        "customer_id": 1,
        "called_id": 1,
        "registered_by": "MikWeb",
        "modified_by": null,
        "created_at": "2021-05-24T12:37:32.000Z",
        "updated_at": "2021-05-24T12:37:32.000Z"
    }
}

POST https://api.mikweb.com.br/v1/admin/calledies/1/answer_create

Este endpoint cadastrará uma Resposta associada a um Chamado de acordo com os parâmetros passados.

Parâmetros que podem ser urtilizados para cadastrar/atualizar uma Resposta

Parâmerto	Tipo	Descrição	Validações
`message` *	text	Mensagem em resposta ao Chamado

Os parâmetros marcados com asterisco * são obrigatorios!

Parâmetros apenas leitura de uma Resposta

Parâmerto	Tipo	Descrição	Validações
`id`	integer	Identificador Unico (ID) da Resposta.
`customer_id`	integer	Identificador Unico (ID) do Cliente.
`called_id`	integer	Identificador Unico (ID) do Chamado.
`registered_by`	string	Identificação do usuário responsavel pela criação da Resposta.
`modified_by`	string	Identificação do usuário responsavel pela atualização da Resposta.
`created_at`	date	Data de criação da Resposta.	dd-MM-yyyy
`updated_at`	date	Data de atualização da Resposta.	dd-MM-yyyy

Atualizando uma Resposta

Requisição de Atualização

curl "https://api.mikweb.com.br/v1/admin/calledies/1/answer_update"  \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{
        \"message\": \"Instalação realizada com sucesso, na casa do cliente.\"
      }"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "answer": {
        "id": 1,
        "message": "Instalação realizada com sucesso, na casa do cliente.",
        "customer_id": 1,
        "called_id": 1,
        "registered_by": "MikWeb",
        "modified_by": "MikWeb",
        "created_at": "2021-05-24T12:22:24.000Z",
        "updated_at": "2021-05-24T13:29:27.000Z"
    }
}

PUT https://api.mikweb.com.br/v1/admin/calledies/<ID>/answer_update

Este endpoint atualizará uma Resposta especifica. Que será identificado através do <ID>.

Substitua ID por um ID válido de uma Resposta.

Deletando uma Resposta

Requisição para Deletar

curl "https://api.mikweb.com.br/v1/admin/calledies/1/answer_destroy" \
  -X DELETE \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

DELETE DELETE https://api.mikweb.com.br/v1/admin/calledies/<ID>/answer_destroy

Este endpoint excluirá uma Resposta especifica. Que será identificado através do <ID> da Resposta.

O comando acima retornará apenas o status code: 204, quando executado com sucesso.

Listando Respostas

Requisição de Listagem

curl "https://api.mikweb.com.br/v1/admin/calledies/answers" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "answers": [...],
    "meta": {
        "pages": {
            "current_page": 1,
            "next_page": null,
            "prev_page": null,
            "total_pages": 1,
            "total_count": 1
        },
        "statistics": false
    }
}

GET https://api.mikweb.com.br/v1/admin/calledies/answers

Este endpoint retornará uma listagem de respostas.

Parâmetros que podem ser usados para filtrar Respostas

Parâmerto	Tipo	Descrição	Opções
`called_id`	integer	Filtra as respostas por ID do Chamado.

Tipos de Chamado

Cadastrando um Tipo de Chamado

Requisição de Cadastro

curl "https://api.mikweb.com.br/v1/admin/called_types" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{
        \"description\": \"Instalação\"
     }"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "called_type": {
        "id": 1,
        "description": "Instalação",
        "created_at": "2021-05-24T14:19:50.000Z",
        "updated_at": "2021-05-24T14:19:50.000Z"
    }
}

POST https://api.mikweb.com.br/v1/admin/called_types

Este endpoint cadastrará um Tipo de Chamado de acordo com os parâmetros passados.

Parâmetros que podem ser urtilizados para cadastrar/atualizar um Chamado

Parâmerto	Tipo	Descrição	Validações
`description` *	string	Breve descrição do tipo do chamado	Max: 255

Os parâmetros marcados com asterisco * são obrigatorios!

Parâmetros apenas leitura de um Tipo de Chamado

Parâmerto	Tipo	Descrição	Validações
`id`	integer	Identificador Unico (ID) do Tipo do Chamado.
`created_at`	date	Data de criação do Tipo do Chamado.	dd-MM-yyyy
`updated_at`	date	Data de atualização do Tipo do Chamado.	dd-MM-yyyy

Consultando um Tipo de Chamado

Requisição de Consulta

curl "https://api.mikweb.com.br/v1/admin/called_types/1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "called_type": {
        "id": 1,
        "description": "Instalação",
        "created_at": "2021-05-24T14:19:50.000Z",
        "updated_at": "2021-05-24T14:19:50.000Z"
    }
}

GET https://api.mikweb.com.br/v1/admin/called_types/<ID>

Este endpoint retornará um Tipo de Chamado especifico. Que será identificada através do <ID>.

Substitua ID por um ID válido.

Atualizando um Tipo de Chamado

Requisição de Atualização

curl "https://api.mikweb.com.br/v1/admin/called_types/1"  \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{
        \"description\": \"Manutenção\"
      }"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "called_type": {
        "id": 1,
        "description": "Manutenção",
        "created_at": "2021-05-24T14:19:50.000Z",
        "updated_at": "2021-05-24T14:29:09.000Z"
    }
}

PUT https://api.mikweb.com.br/v1/admin/called_types/<ID>

Este endpoint atualizará um Tipo de Chamado especifico. Que será identificado através do <ID>.

Substitua ID por um ID válido.

Listando Tipos de Chamado

Requisição de Listagem

curl "https://api.mikweb.com.br/v1/admin/called_types" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "called_types": [
        {
            "id": 1,
            "description": "Instalação",
            "created_at": "2021-05-24T14:15:20.000Z",
            "updated_at": "2021-05-24T14:15:20.000Z"
        },
        {
            "id": 2,
            "description": "Manutenção",
            "created_at": "2021-05-24T14:19:50.000Z",
            "updated_at": "2021-05-24T14:29:09.000Z"
        }
    ]
}

GET https://api.mikweb.com.br/v1/admin/called_types

Este endpoint retornará uma listagem de Tipos de Chamado.

Deletando um Tipo de Chamado

Requisição para Deletar

curl "https://api.mikweb.com.br/v1/admin/called_types/1" \
  -X DELETE \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

DELETE DELETE https://api.mikweb.com.br/v1/admin/called_types/<ID>

Este endpoint excluirá um Tipo de Chamado especifico. Que será identificado através do <ID>.

O comando acima retornará apenas o status code: 204, quando executado com sucesso.

Técnicos

Cadastrando um Técnico

Requisição de Cadastro

curl "https://api.mikweb.com.br/v1/admin/technicals" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{
        \"name\": \"Paulo Vinicius\",
        \"active\": true
     }"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "technical": {
        "id": 1,
        "name": "Paulo Vinicius",
        "active": true
    }
}

POST https://api.mikweb.com.br/v1/admin/technicals

Este endpoint cadastrará um Técnico de acordo com os parâmetros passados.

Parâmetros que podem ser urtilizados para cadastrar/atualizar um Técnico

Parâmerto	Tipo	Descrição	Validações
`name` *	string	Nome do Técnico a ser cadastrado	Max: 255
`active`	boolean	Status do Técnico.

Os parâmetros marcados com asterisco * são obrigatorios!

Parâmetros apenas leitura de um Técnico

Parâmerto	Tipo	Descrição	Validações
`id`	integer	Identificador Unico (ID) do Técnico.

Consultando um Técnico

Requisição de Consulta

curl "https://api.mikweb.com.br/v1/admin/technicals/1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "technical": {
        "id": 1,
        "name": "Paulo Vinicius",
        "active": true
    }
}

GET https://api.mikweb.com.br/v1/admin/technicals/<ID>

Este endpoint retornará um Técnico especifico. Que será identificada através do <ID>.

Substitua ID por um ID válido.

Atualizando um Técnico

Requisição de Atualização

curl "https://api.mikweb.com.br/v1/admin/technicals/1"  \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>" \
  -d "{
        \"name\": \"Paulo\",
        \"active\": false
      }"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "technical": {
        "id": 1,
        "name": "Paulo",
        "active": false
    }
}

PUT https://api.mikweb.com.br/v1/admin/technicals/<ID>

Este endpoint atualizará um Técnico especifico. Que será identificado através do <ID>.

Substitua ID por um ID válido.

Listando Técnicos

Requisição de Listagem

curl "https://api.mikweb.com.br/v1/admin/technicals" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

O comando acima retornará um objeto JSON similar ao abaixo:

{
    "technicals": [
        {
            "id": 1,
            "name": "Paulo Vinicius",
            "active": true
        }
    ]
}

GET https://api.mikweb.com.br/v1/admin/technicals

Este endpoint retornará uma listagem de Técnicos.

Deletando um Técnico

Requisição para Deletar

curl "https://api.mikweb.com.br/v1/admin/technicals/1" \
  -X DELETE \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <seu-token>"

DELETE DELETE https://api.mikweb.com.br/v1/admin/technicals/<ID>

Este endpoint excluirá um Técnico especifico. Que será identificado através do <ID>.

O comando acima retornará apenas o status code: 204, quando executado com sucesso.

Errors

A API MikWeb usa os seguintes códigos de erro:

HTTP Status	Descrição
`400`	Bad Request -- Requisição invalida.
`401`	Unauthorized -- Autenticação invalida.
`403`	Forbidden -- Sem permissão de acesso.
`404`	Not Found -- Parâmetro de consulta sem correspondência.
`406`	Not Acceptable -- Requisição fora do formato JSON.
`422`	Unprocessable Entity -- Valor de parâmetro inválido.
`429`	Too Many Requests -- Excedeu o limite de requisições por minuto.
`500`	Internal Server Error -- Erro interno no servidor.

Introdução

Endpoint da API

https://api.mikweb.com.br/v1/admin/

Autenticação

Clientes

Cadastrando um Cliente

Parâmetros que podem ser urtilizados para cadastrar/atualizar um cliente

Consultando um Cliente

Atualizando um Cliente

Desconectando um Cliente

Alterando o Status de um Cliente

Opções para o parâmetro status

Alterando o Status de Acesso de um Cliente

Opções para o parâmetro msg_payment_mk

Listando Clientes

Parâmetros que podem ser usados para filtrar clientes

Campos disponíveis para pesquisa

Deletando um Cliente

Cobranças

Cadastrando uma Cobrança

Parâmetros que podem ser urtilizados para cadastrar/atualizar uma Cobrança

Parâmetros apenas leitura de uma Cobrança

Consultando uma Cobrança

Atualizando uma Cobrança

Deletando uma Cobrança

Confirmando uma Cobrança

Parâmetros para confirmação

Colocando em Observação

Removendo a Observação

Listando Cobranças

Parâmetros que podem ser usados para filtrar cobranças

Campos disponíveis para pesquisa

Opções de filtro por data

Opções de Ordenação

Download de uma Cobrança

Link PagSeguro

Situações das Cobranças

Situações possíveis de uma Cobrança

Formas de Cobrança

Formas de cobranças disponíveis no MikWeb

Carnês

Cadastrando um Carnê

Parâmetros que podem ser urtilizados para cadastrar um Carnê

Parâmetros apenas leitura de uma Cobrança

Consultando um Carnê

Download de um Carnê

Listando Carnês

Parâmetros que podem ser usados para filtrar carnês

Campos disponíveis para pesquisa

Opções de filtro por data

Deletando um Carnê

Arquivando um Carnê

Status de Carnês

Status possíveis de um Carnê

Chamados

Cadastrando um Chamado

Parâmetros que podem ser urtilizados para cadastrar/atualizar um Chamado

Parâmetros apenas leitura de um Chamado

Consultando um Chamado

Atualizando um Chamado

Deletando um Chamado

Listando Chamados

Parâmetros que podem ser usados para filtrar Chamados

Campos disponíveis para pesquisa

Opções de filtro por data

Finalizando um Chamado

Rastaurando um Chamado

Cadastrando uma Resposta

Parâmetros que podem ser urtilizados para cadastrar/atualizar uma Resposta

Parâmetros apenas leitura de uma Resposta

Atualizando uma Resposta

Deletando uma Resposta

Listando Respostas

Parâmetros que podem ser usados para filtrar Respostas

Tipos de Chamado

Cadastrando um Tipo de Chamado

Parâmetros que podem ser urtilizados para cadastrar/atualizar um Chamado

Parâmetros apenas leitura de um Tipo de Chamado

Consultando um Tipo de Chamado

Atualizando um Tipo de Chamado

Opções para o parâmetro `status`

Opções para o parâmetro `msg_payment_mk`