Pular para o conteúdo principal

kobana banking mailbox

Caixa postal (EDI, arquivos)

Comandos de kobana banking mailbox. Toda opção global (Opções globais) vale aqui.

ComandoHTTPDescrição
mailbox entries emailGET /v2/mailbox/entries/{entry_uid}/emailExibir Canal de E-mail
mailbox entries email activatePUT /v2/mailbox/entries/{entry_uid}/email/activateAtivar Canal de E-mail
mailbox entries email deactivatePUT /v2/mailbox/entries/{entry_uid}/email/deactivateDesativar Canal de E-mail
mailbox entries email createPOST /v2/mailbox/entries/{entry_uid}/emailCriar Canal de E-mail
mailbox entries email updatePATCH /v2/mailbox/entries/{entry_uid}/emailAtualizar Canal de E-mail
mailbox entries email deleteDELETE /v2/mailbox/entries/{entry_uid}/emailExcluir Canal de E-mail
mailbox entries s3GET /v2/mailbox/entries/{entry_uid}/s3Exibir Canal S3
mailbox entries s3 activatePUT /v2/mailbox/entries/{entry_uid}/s3/activateAtivar Canal S3
mailbox entries s3 deactivatePUT /v2/mailbox/entries/{entry_uid}/s3/deactivateDesativar Canal S3
mailbox entries s3 fetchPUT /v2/mailbox/entries/{entry_uid}/s3/fetchBuscar arquivos do Canal S3
mailbox entries s3 update-passwordPUT /v2/mailbox/entries/{entry_uid}/s3/update_passwordAtualizar credenciais AWS do Canal S3
mailbox entries s3 createPOST /v2/mailbox/entries/{entry_uid}/s3Criar Canal S3
mailbox entries s3 deleteDELETE /v2/mailbox/entries/{entry_uid}/s3Excluir Canal S3
mailbox entries sftpGET /v2/mailbox/entries/{entry_uid}/sftpExibir Canal SFTP
mailbox entries sftp activatePUT /v2/mailbox/entries/{entry_uid}/sftp/activateAtivar Canal SFTP
mailbox entries sftp deactivatePUT /v2/mailbox/entries/{entry_uid}/sftp/deactivateDesativar Canal SFTP
mailbox entries sftp fetchPUT /v2/mailbox/entries/{entry_uid}/sftp/fetchBuscar arquivos do Canal SFTP
mailbox entries sftp update-passwordPUT /v2/mailbox/entries/{entry_uid}/sftp/update_passwordAtualizar credenciais SSH do Canal SFTP
mailbox entries sftp createPOST /v2/mailbox/entries/{entry_uid}/sftpCriar Canal SFTP
mailbox entries sftp updatePATCH /v2/mailbox/entries/{entry_uid}/sftpAtualizar Canal SFTP
mailbox entries sftp deleteDELETE /v2/mailbox/entries/{entry_uid}/sftpExcluir Canal SFTP
mailbox entries syncthingGET /v2/mailbox/entries/{entry_uid}/syncthingExibir Canal Syncthing
mailbox entries syncthing activatePUT /v2/mailbox/entries/{entry_uid}/syncthing/activateAtivar Canal Syncthing
mailbox entries syncthing deactivatePUT /v2/mailbox/entries/{entry_uid}/syncthing/deactivateDesativar Canal Syncthing
mailbox entries syncthing resend-invitesPUT /v2/mailbox/entries/{entry_uid}/syncthing/resend_invitesReenviar Convites Syncthing
mailbox entries syncthing update-statusPUT /v2/mailbox/entries/{entry_uid}/syncthing/update_statusAtualizar Status do Servidor Syncthing
mailbox entries syncthing createPOST /v2/mailbox/entries/{entry_uid}/syncthingCriar Canal Syncthing
mailbox entries syncthing updatePATCH /v2/mailbox/entries/{entry_uid}/syncthingAtualizar Canal Syncthing
mailbox entries syncthing deleteDELETE /v2/mailbox/entries/{entry_uid}/syncthingExcluir Canal Syncthing
mailbox entries whatsappGET /v2/mailbox/entries/{entry_uid}/whatsappExibir Canal WhatsApp
mailbox entries whatsapp activatePUT /v2/mailbox/entries/{entry_uid}/whatsapp/activateAtivar Canal WhatsApp
mailbox entries whatsapp deactivatePUT /v2/mailbox/entries/{entry_uid}/whatsapp/deactivateDesativar Canal WhatsApp
mailbox entries whatsapp createPOST /v2/mailbox/entries/{entry_uid}/whatsappCriar Canal WhatsApp
mailbox entries whatsapp updatePATCH /v2/mailbox/entries/{entry_uid}/whatsappAtualizar Canal WhatsApp
mailbox entries whatsapp deleteDELETE /v2/mailbox/entries/{entry_uid}/whatsappExcluir Canal WhatsApp
mailbox entries listGET /v2/mailbox/entriesListar Caixas Postais
mailbox entries createPOST /v2/mailbox/entriesCriar Caixa Postal
mailbox entries filesPOST /v2/mailbox/entries/{entry_uid}/filesCriar Arquivo de Mailbox
mailbox entries getGET /v2/mailbox/entries/{uid}Visualizar Caixa Postal
mailbox entries updatePATCH /v2/mailbox/entries/{uid}Atualizar Caixa Postal
mailbox entries deleteDELETE /v2/mailbox/entries/{uid}Deletar Caixa Postal
mailbox files listGET /v2/mailbox/filesListar Arquivos de Mailbox
mailbox files getGET /v2/mailbox/files/{uid}Visualizar Arquivo de Mailbox
mailbox files updatePATCH /v2/mailbox/files/{uid}Atualizar Arquivo de Mailbox
mailbox files deleteDELETE /v2/mailbox/files/{uid}Deletar Arquivo de Mailbox

mailbox entries email​

Exibir Canal de E-mail

kobana banking mailbox entries email [ENTRY_UID] [OPÇÕES] [COMANDO]

GET /v2/mailbox/entries/{entry_uid}/email

Retorna o canal de e-mail configurado na Caixa Postal.

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
200Canal de e-mail encontrado.
404Canal não encontrado.

mailbox entries email activate​

Ativar Canal de E-mail

kobana banking mailbox entries email activate [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/email/activate

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Ativação enfileirada.

mailbox entries email deactivate​

Desativar Canal de E-mail

kobana banking mailbox entries email deactivate [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/email/deactivate

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Desativação enfileirada.

mailbox entries email create​

Criar Canal de E-mail

kobana banking mailbox entries email create [ENTRY_UID] [OPÇÕES]

POST /v2/mailbox/entries/{entry_uid}/email

Cria um canal de e-mail para a Caixa Postal.

Argumentos do caminho: entry_uid

Corpo da requisição

NomeTipoObrigatórioDescrição
inbox_emailsarray<object>não
outbox_emailsarray<object>não

Outros campos e objetos aninhados: kobana schema banking.mailbox.entries.email.create.

Respostas

HTTPDescrição
201Canal criado.

mailbox entries email update​

Atualizar Canal de E-mail

kobana banking mailbox entries email update [ENTRY_UID] [OPÇÕES]

PATCH /v2/mailbox/entries/{entry_uid}/email

Argumentos do caminho: entry_uid

Corpo da requisição

NomeTipoObrigatórioDescrição
inbox_emailsarray<object>não
outbox_emailsarray<object>não

Outros campos e objetos aninhados: kobana schema banking.mailbox.entries.email.update.

Respostas

HTTPDescrição
200Canal atualizado.
404Canal não encontrado.

mailbox entries email delete​

Excluir Canal de E-mail

kobana banking mailbox entries email delete [ENTRY_UID] [OPÇÕES]

DELETE /v2/mailbox/entries/{entry_uid}/email

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
204Canal excluído.
422Canal ativo não pode ser excluído.

mailbox entries s3​

Exibir Canal S3

kobana banking mailbox entries s3 [ENTRY_UID] [OPÇÕES] [COMANDO]

GET /v2/mailbox/entries/{entry_uid}/s3

Retorna o canal S3 configurado na Caixa Postal.

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
200Canal S3 encontrado.
404Canal não encontrado.

mailbox entries s3 activate​

Ativar Canal S3

kobana banking mailbox entries s3 activate [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/s3/activate

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Ativação enfileirada.

mailbox entries s3 deactivate​

Desativar Canal S3

kobana banking mailbox entries s3 deactivate [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/s3/deactivate

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Desativação enfileirada.

mailbox entries s3 fetch​

Buscar arquivos do Canal S3

kobana banking mailbox entries s3 fetch [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/s3/fetch

Enfileira a busca de arquivos do bucket S3 configurado.

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Busca enfileirada.

mailbox entries s3 update-password​

Atualizar credenciais AWS do Canal S3

kobana banking mailbox entries s3 update-password [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/s3/update_password

Enfileira a atualização das credenciais AWS da Caixa Postal e define o canal como atualizando senha.

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Atualização enfileirada.

mailbox entries s3 create​

Criar Canal S3

kobana banking mailbox entries s3 create [ENTRY_UID] [OPÇÕES]

POST /v2/mailbox/entries/{entry_uid}/s3

Cria um canal S3 para a Caixa Postal.

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
201Canal criado.

mailbox entries s3 delete​

Excluir Canal S3

kobana banking mailbox entries s3 delete [ENTRY_UID] [OPÇÕES]

DELETE /v2/mailbox/entries/{entry_uid}/s3

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
204Canal excluído.
422Canal ativo não pode ser excluído.

mailbox entries sftp​

Exibir Canal SFTP

kobana banking mailbox entries sftp [ENTRY_UID] [OPÇÕES] [COMANDO]

GET /v2/mailbox/entries/{entry_uid}/sftp

Retorna o canal SFTP configurado na Caixa Postal.

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
200Canal SFTP encontrado.
404Canal não encontrado.

mailbox entries sftp activate​

Ativar Canal SFTP

kobana banking mailbox entries sftp activate [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/sftp/activate

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Ativação enfileirada.

mailbox entries sftp deactivate​

Desativar Canal SFTP

kobana banking mailbox entries sftp deactivate [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/sftp/deactivate

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Desativação enfileirada.

mailbox entries sftp fetch​

Buscar arquivos do Canal SFTP

kobana banking mailbox entries sftp fetch [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/sftp/fetch

Enfileira a busca de arquivos do servidor SFTP configurado.

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Busca enfileirada.

mailbox entries sftp update-password​

Atualizar credenciais SSH do Canal SFTP

kobana banking mailbox entries sftp update-password [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/sftp/update_password

Enfileira a atualização das credenciais SSH da Caixa Postal e define o canal como atualizando senha.

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Atualização enfileirada.

mailbox entries sftp create​

Criar Canal SFTP

kobana banking mailbox entries sftp create [ENTRY_UID] [OPÇÕES]

POST /v2/mailbox/entries/{entry_uid}/sftp

Cria um canal SFTP para a Caixa Postal.

Argumentos do caminho: entry_uid

Corpo da requisição

NomeTipoObrigatórioDescrição
keystringnãoChave privada SSH (write-only)

Outros campos e objetos aninhados: kobana schema banking.mailbox.entries.sftp.create.

Respostas

HTTPDescrição
201Canal criado.

mailbox entries sftp update​

Atualizar Canal SFTP

kobana banking mailbox entries sftp update [ENTRY_UID] [OPÇÕES]

PATCH /v2/mailbox/entries/{entry_uid}/sftp

Atualiza o canal SFTP. Campo password e campos gerenciados pelo sistema (host, port, inbox_path, outbox_path) não são aceitos via API.

Argumentos do caminho: entry_uid

Corpo da requisição

NomeTipoObrigatórioDescrição
keystringnãoChave privada SSH (write-only)

Outros campos e objetos aninhados: kobana schema banking.mailbox.entries.sftp.update.

Respostas

HTTPDescrição
200Canal atualizado.
404Canal não encontrado.

mailbox entries sftp delete​

Excluir Canal SFTP

kobana banking mailbox entries sftp delete [ENTRY_UID] [OPÇÕES]

DELETE /v2/mailbox/entries/{entry_uid}/sftp

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
204Canal excluído.
422Canal ativo não pode ser excluído.

mailbox entries syncthing​

Exibir Canal Syncthing

kobana banking mailbox entries syncthing [ENTRY_UID] [OPÇÕES] [COMANDO]

GET /v2/mailbox/entries/{entry_uid}/syncthing

Retorna o canal Syncthing configurado na Caixa Postal.

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
200Canal Syncthing encontrado.
404Canal não encontrado.

mailbox entries syncthing activate​

Ativar Canal Syncthing

kobana banking mailbox entries syncthing activate [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/syncthing/activate

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Ativação enfileirada.

mailbox entries syncthing deactivate​

Desativar Canal Syncthing

kobana banking mailbox entries syncthing deactivate [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/syncthing/deactivate

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Desativação enfileirada.

mailbox entries syncthing resend-invites​

Reenviar Convites Syncthing

kobana banking mailbox entries syncthing resend-invites [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/syncthing/resend_invites

Reenvia os convites de ativação do canal Syncthing, forçando o processo de ativação.

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Reenvio de convites enfileirado.

mailbox entries syncthing update-status​

Atualizar Status do Servidor Syncthing

kobana banking mailbox entries syncthing update-status [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/syncthing/update_status

Solicita atualização do status de conexão com o servidor Syncthing.

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Atualização de status enfileirada.

mailbox entries syncthing create​

Criar Canal Syncthing

kobana banking mailbox entries syncthing create [ENTRY_UID] [OPÇÕES]

POST /v2/mailbox/entries/{entry_uid}/syncthing

Cria um canal Syncthing para a Caixa Postal. O device_id deve seguir o formato padrão do Syncthing.

Argumentos do caminho: entry_uid

Corpo da requisição

NomeTipoObrigatórioDescrição
namestringsim
device_idstringsim

Outros campos e objetos aninhados: kobana schema banking.mailbox.entries.syncthing.create.

Respostas

HTTPDescrição
201Canal criado.

mailbox entries syncthing update​

Atualizar Canal Syncthing

kobana banking mailbox entries syncthing update [ENTRY_UID] [OPÇÕES]

PATCH /v2/mailbox/entries/{entry_uid}/syncthing

Atualiza o nome ou device_id do canal Syncthing.

Argumentos do caminho: entry_uid

Corpo da requisição

NomeTipoObrigatórioDescrição
namestringnão
device_idstringnão

Outros campos e objetos aninhados: kobana schema banking.mailbox.entries.syncthing.update.

Respostas

HTTPDescrição
200Canal atualizado.
404Canal não encontrado.

mailbox entries syncthing delete​

Excluir Canal Syncthing

kobana banking mailbox entries syncthing delete [ENTRY_UID] [OPÇÕES]

DELETE /v2/mailbox/entries/{entry_uid}/syncthing

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
204Canal excluído.
422Canal ativo não pode ser excluído.

mailbox entries whatsapp​

Exibir Canal WhatsApp

kobana banking mailbox entries whatsapp [ENTRY_UID] [OPÇÕES] [COMANDO]

GET /v2/mailbox/entries/{entry_uid}/whatsapp

Retorna o canal WhatsApp configurado na Caixa Postal.

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
200Canal WhatsApp encontrado.
404Canal não encontrado.

mailbox entries whatsapp activate​

Ativar Canal WhatsApp

kobana banking mailbox entries whatsapp activate [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/whatsapp/activate

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Ativação enfileirada.

mailbox entries whatsapp deactivate​

Desativar Canal WhatsApp

kobana banking mailbox entries whatsapp deactivate [ENTRY_UID] [OPÇÕES]

PUT /v2/mailbox/entries/{entry_uid}/whatsapp/deactivate

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
202Desativação enfileirada.

mailbox entries whatsapp create​

Criar Canal WhatsApp

kobana banking mailbox entries whatsapp create [ENTRY_UID] [OPÇÕES]

POST /v2/mailbox/entries/{entry_uid}/whatsapp

Cria um canal WhatsApp para a Caixa Postal. O activation_token é gerado automaticamente.

Argumentos do caminho: entry_uid

Corpo da requisição

NomeTipoObrigatórioDescrição
inbox_phonesarray<object>não
outbox_phonesarray<object>não

Outros campos e objetos aninhados: kobana schema banking.mailbox.entries.whatsapp.create.

Respostas

HTTPDescrição
201Canal criado.

mailbox entries whatsapp update​

Atualizar Canal WhatsApp

kobana banking mailbox entries whatsapp update [ENTRY_UID] [OPÇÕES]

PATCH /v2/mailbox/entries/{entry_uid}/whatsapp

Atualiza os telefones do canal WhatsApp. O activation_token não é aceito como parâmetro.

Argumentos do caminho: entry_uid

Corpo da requisição

NomeTipoObrigatórioDescrição
inbox_phonesarray<object>não
outbox_phonesarray<object>não

Outros campos e objetos aninhados: kobana schema banking.mailbox.entries.whatsapp.update.

Respostas

HTTPDescrição
200Canal atualizado.
404Canal não encontrado.

mailbox entries whatsapp delete​

Excluir Canal WhatsApp

kobana banking mailbox entries whatsapp delete [ENTRY_UID] [OPÇÕES]

DELETE /v2/mailbox/entries/{entry_uid}/whatsapp

Argumentos do caminho: entry_uid

Respostas

HTTPDescrição
204Canal excluído.
422Canal ativo não pode ser excluído.

mailbox entries list​

Listar Caixas Postais

kobana banking mailbox entries list [OPÇÕES]

GET /v2/mailbox/entries

Lista as Caixas Postais da conta.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
per_pageintegernãoQuantidade de registros por página. Máximo de 50.
pageintegernãoNúmero da página.

Respostas

HTTPDescrição
200Caixas Postais encontradas.

mailbox entries create​

Criar Caixa Postal

kobana banking mailbox entries create [OPÇÕES]

POST /v2/mailbox/entries

Cria uma nova Caixa Postal.

Corpo da requisição

O corpo não é um objeto simples (ou tem variantes). Veja kobana schema banking.mailbox.entries.create.

Respostas

HTTPDescrição
201Caixa Postal criada
422Falha na validação

mailbox entries files​

Criar Arquivo de Mailbox

kobana banking mailbox entries files [ENTRY_UID] [OPÇÕES]

POST /v2/mailbox/entries/{entry_uid}/files

Cria um novo Arquivo de Mailbox associado a uma Caixa Postal.

Argumentos do caminho: entry_uid

Corpo da requisição

O corpo não é um objeto simples (ou tem variantes). Veja kobana schema banking.mailbox.entries.files.

Respostas

HTTPDescrição
201Arquivo criado
422Base64 inválido.

mailbox entries get​

Visualizar Caixa Postal

kobana banking mailbox entries get [UID] [OPÇÕES]

GET /v2/mailbox/entries/{uid}

Consulta informações de uma Caixa Postal específica.

Argumentos do caminho: uid

Respostas

HTTPDescrição
200Caixa Postal encontrada
404Caixa Postal não encontrada

mailbox entries update​

Atualizar Caixa Postal

kobana banking mailbox entries update [UID] [OPÇÕES]

PATCH /v2/mailbox/entries/{uid}

Atualiza uma Caixa Postal específica.

Argumentos do caminho: uid

Corpo da requisição

O corpo não é um objeto simples (ou tem variantes). Veja kobana schema banking.mailbox.entries.update.

Respostas

HTTPDescrição
200Caixa Postal atualizada
404Caixa Postal não encontrada

mailbox entries delete​

Deletar Caixa Postal

kobana banking mailbox entries delete [UID] [OPÇÕES]

DELETE /v2/mailbox/entries/{uid}

Deleta uma Caixa Postal específica. Não é possível deletar uma Caixa Postal que possui arquivos.

Argumentos do caminho: uid

Respostas

HTTPDescrição
204Caixa Postal deletada
404Caixa Postal não encontrada
422Caixa Postal possui arquivos ou não pode ser excluída

mailbox files list​

Listar Arquivos de Mailbox

kobana banking mailbox files list [OPÇÕES]

GET /v2/mailbox/files

Lista os Arquivos de Mailbox da conta.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
per_pageintegernãoQuantidade de registros por página. Máximo de 50.
pageintegernãoNúmero da página.

Respostas

HTTPDescrição
200Arquivos encontrados.

mailbox files get​

Visualizar Arquivo de Mailbox

kobana banking mailbox files get [UID] [OPÇÕES]

GET /v2/mailbox/files/{uid}

Consulta informações de um Arquivo de Mailbox específico.

Argumentos do caminho: uid

Respostas

HTTPDescrição
200Arquivo encontrado
404Arquivo não encontrado

mailbox files update​

Atualizar Arquivo de Mailbox

kobana banking mailbox files update [UID] [OPÇÕES]

PATCH /v2/mailbox/files/{uid}

Atualiza um Arquivo de Mailbox específico.

Argumentos do caminho: uid

Corpo da requisição

O corpo não é um objeto simples (ou tem variantes). Veja kobana schema banking.mailbox.files.update.

Respostas

HTTPDescrição
200Arquivo atualizado
404Arquivo não encontrado

mailbox files delete​

Deletar Arquivo de Mailbox

kobana banking mailbox files delete [UID] [OPÇÕES]

DELETE /v2/mailbox/files/{uid}

Deleta um Arquivo de Mailbox específico.

Argumentos do caminho: uid

Respostas

HTTPDescrição
204Arquivo deletado
404Arquivo não encontrado