Appearance
Alteração de Conferências
Esta api permite fazer a alteração dos campos custom das conferências via HTTP PATCH.
API
Caminho /conference
shell
curl 'http://SERVER:PORT/api/conference' \
-H 'Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4'
Json enviado
json
[
{
"id": "19576ed5-0a86-4f40-baf0-bedae31761da",
"custom": {
"Teste1": "Teste1",
"Teste2": 123
}
},
{
"id": "ee9e74ea-9aae-4c7c-810d-e048835f4892",
"custom": {
"Teste1": "abc",
"Teste2": 456
}
}
]
Resposta em caso de sucesso
json
{
"conferences": [
{
"id": "19576ed5-0a86-4f40-baf0-bedae31761da",
"createdAt": "2024-11-29 11:35:26.257",
"createdBy": "valesoft",
"updatedAt": "2024-12-02 14:20:58.510",
"updatedBy": "valesoft",
"custom": {
"Teste1": "Teste1",
"Teste2": 123
},
"integrated": false,
"invoice": {
"id": "f277ffed-839f-49cd-b4b6-3c85d5791eb7"
},
"type": "RECEIPT",
"place": {
"id": "0759665d-960f-4f56-a1dd-0c436e8b8817"
},
"status": "DONE",
"justification": null
},
{
"id": "ee9e74ea-9aae-4c7c-810d-e048835f4892",
"createdAt": "2024-11-29 11:35:26.257",
"createdBy": "valesoft",
"updatedAt": "2024-12-02 14:20:58.510",
"updatedBy": "valesoft",
"custom": {
"Teste1": "Teste1",
"Teste2": 123
},
"integrated": false,
"invoice": {
"id": "f277ffed-839f-49cd-b4b6-3c85d5791eb7"
},
"type": "RECEIPT",
"place": {
"id": "0759665d-960f-4f56-a1dd-0c436e8b8817"
},
"status": "DONE",
"justification": null
}
],
"error": {}
}
Descrição dos campos
Campos do JSON enviado:
id
- Identificador da conferênciacustom
- Campos customizados
Campos do retorno:
conferences
- Lista das conferências salvaserror
- Erros para cada conferência
Autenticação
A chamada para esses endpoints necessitam autenticação do tipo Basic
(Base64 encoded) com credenciais de um usuário devidamente cadastrado no sistema Valesoft. Ex: Usuário integração com senha 12345678
integração:12345678
=> Base64 encoded =>aW50ZWdyYcOnw6NvOjEyMzQ1Njc4
- Header de autenticação =>
Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4
Parâmetros da requisição:
SERVER
- O IP ou DNS do servidor onde o sistema Valesoft está instaladoPORT
- A porta definida na instalação do sistema.