Upload de arquivos
O objetivo deste serviço é possibilitar o envio de arquivos para os cadastros, atendimentos e usuários do sistema. Abaixo, segue exemplo do json de envio:
{
"files_upload":[
{
"type": "customer",
"code": 21546,
"filename": "meu_arquivo.pdf",
"file": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlz
IHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlciBhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2Yg
dGhlIG1pbmQsIHRoYXQgYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGlu
dWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRo
ZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
"visible": "no",
"description": "Planilha de ações"
},
{
"type": "user",
"user": "joao",
"filename": "meu_arquivo2.pdf",
"file": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlz
IHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlciBhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2Yg
dGhlIG1pbmQsIHRoYXQgYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGlu
dWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRo
ZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
"visible": "no",
"description": "Planilha de ações"
}]
}
Detalhamento dos campos
ID | Campo | Obrigatório | Pai | Tipo | Observações |
A01 | Dados do arquivo | Sim | Raiz | - | Podem ser enviados vários arquivos em uma mensagem mensgaem |
A02 | type | Sim | A01 | Texto |
Tipo do arquivo a ser enviado. Opções disponíveis:
|
A03 | code | Sim | A01 | Número |
Código do cadastro ou número do atendimento. |
A04 | user | Sim | A01 | Texto |
Usuário do sistema. |
A05 | filename | Sim | A01 | Texto |
Nome do arquivo com extensão. |
A06 | file | Sim | A01 | Texto |
Conteúdo do arquivo codificado em base64. |
A07 | visible | Sim | A01 | Texto |
Define se o arquivo estará visível para o cliente. Opções disponíveis:
|
A08 | description | Sim | A01 | Texto |
Descrição do arquivo no sistema. |
Mensagem de retorno
Em caso de sucesso, será retornado um json conforme o exemplo abaixo:
{
"status": 1,
"error_code": 0,
"error_description": "",
"result": [
{
"id": 10,
"type": "customer",
"code": 21546,
"filename": "meu_arquivo.pdf",
"file": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlz
IHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlciBhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2Yg
dGhlIG1pbmQsIHRoYXQgYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGlu
dWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRo
ZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
"visible": "no",
"description": "Planilha de ações"
},
{
"id": 11,
"type": "user",
"user": "joao",
"filename": "meu_arquivo2.pdf",
"file": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlz
IHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlciBhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2Yg
dGhlIG1pbmQsIHRoYXQgYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGlu
dWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRo
ZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
"visible": "no",
"description": "Planilha de ações"
}]
}
Em caso de falha, será retornado um json conforme o exemplo abaixo:
{
"status": 0,
"error_code": 5,
"error_description": "The field file is required!",
"result": ""
}