API PABX - Gerenciar Perfis de Horário
✅Endereço de Chamada da API
GET /api/manageTimeProfiles/API_TOKEN/API_KEY/0
Este Ponto de Acesso permite que você obtenha os Perfis de Horário de um Cliente. Repare que no final da URL, você poderá informar o número 0 ou informar o ID de um Assinante para listar apenas os Perfis desse Assinante.
Para nosso exemplo, iremos deduzir que o endereço do servidor será vono.me. Nesse caso, o endereço da API para atualizar um registro:
Endereço da API exemplo
POST https://vono.me/api/manageTimeProfiles/API_TOKEN/API_KEY/0
Parâmetros:
- id_record: ID do registro a ser atualizado
- id_cliente: ID do Cliente dono do Perfil
- descricao: Nome/Descrição do Perfil
- wday0_hora1_ini: Primeiro Horário Inicial para Domingo (Formato: hh:mm:ss)
- wday0_hora1_end: Primeiro Horário Final para Domingo
- wday0_hora2_ini: Segundo Horário Inicial para Domingo
- wday0_hora2_end: Segundo Horário Final para Domingo
- wday1_hora1_ini: Primeiro Horário Inicial para Segunda-Feira
- wday1_hora1_end: Primeiro Horário Final para Segunda-Feira
- wday1_hora2_ini: Segundo Horário Inicial para Segunda-Feira
- wday1_hora2_end: Segundo Horário Final para Segunda-Feira
- wday2_hora1_ini: Primeiro Horário Inicial para Terça-Feira
- wday2_hora1_end: Primeiro Horário Final para Terça-Feira
- wday2_hora2_ini: Segundo Horário Inicial para Terça-Feira
- wday2_hora2_end: Segundo Horário Final para Terça-Feira
- wday3_hora1_ini: Primeiro Horário Inicial para Quarta-Feira
- wday3_hora1_end: Primeiro Horário Final para Quarta-Feira
- wday3_hora2_ini: Segundo Horário Inicial para Quarta-Feira
- wday3_hora2_end: Segundo Horário Final para Quarta-Feira
- wday4_hora1_ini: Primeiro Horário Inicial para Quinta-Feira
- wday4_hora1_end: Primeiro Horário Final para Quinta-Feira
- wday4_hora2_ini: Segundo Horário Inicial para Quinta-Feira
- wday4_hora2_end: Segundo Horário Final para Quinta-Feira
- wday5_hora1_ini: Primeiro Horário Inicial para Sexta-Feira
- wday5_hora1_end: Primeiro Horário Final para Sexta-Feira
- wday5_hora2_ini: Segundo Horário Inicial para Sexta-Feira
- wday5_hora2_end: Segundo Horário Final para Sexta-Feira
- wday6_hora1_ini: Primeiro Horário Inicial para Sábado
- wday6_hora1_end: Primeiro Horário Final para Sábado
- wday6_hora2_ini: Segundo Horário Inicial para Sábado
- wday6_hora2_end: Segundo Horário Final para Sábado
- status: Status atual do Registro / 0 – Inativo | 1 – Ativo
❕ Caso tenha duvidas de como pegar o domínio, APITOKEN e APIKEY para preencher clique abaixo.
✦ Como pegar o dominio »
✦ Como pegar APITOKEN e APIKEY »
A chamada para obter os dados da consulta, é realizado utilizando um HTTP GET para o endereço de consumo da API. Um exemplo de chamada a essa API para criar um novo registro seria:
$ curl -X PUT -d '{
"id_cliente": 9,
"wday1_hora1_ini": "09:00:00:00",
"wday1_hora1_end": "11:59:59",
"status": 1
}'
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
{
"error": 0,
"reason": "OK",
"new_record": 13
}
A chamada para excluir um registro, é realizado utilizando um HTTP DELETE informando o na query o parâmetro id_record com o ID do registro a ser removido:
$ curl -X DELETE 'https://vono.me/api/manageTimeProfiles/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990
| Campo | Descrição |
|---|---|
| error | 1 em caso de erro |
| reason | Descrição caso tenha ocorrido algum erro |
| new_record | ID do novo Registro |
Conheça o produto relacionado:
Ver solução Vono