Documentação API
Transforme seus documentos com facilidade e eficiência com nossa API
Sumário
Arquivo Postman e explicação das rotas
Para facilitar a integração e o teste da nossa API, disponibilizamos um arquivo Postman que contém todas as rotas necessárias. Esse arquivo permite que você experimente nossas funcionalidades de forma rápida e eficiente.
Download do arquivo Postman
Você pode baixar o arquivo Postman clicando no link abaixo:
Importando o arquivo Postman
Para importar o arquivo Postman em sua aplicação Postman, siga os passos abaixo:
- Abra o Postman.
- Clique em Import no canto superior esquerdo.
- Selecione o arquivo que você baixou e clique em Open.
- O arquivo será importado e você verá uma coleção contendo todas as rotas disponíveis.
Explicação das rotas
Versão da API
V1: https://apiia.uxdoc.com.br
Enviar documento para fila de processamento
Nesta seção, vamos explicar como enviar um documento para a fila de processamento da nossa API. Esta rota permite que você envie um documento em formato Word, que será processado e transformado conforme as configurações fornecidas.
Rota: Enviar Documento
Método: PATCH
URL: {{ _.baseURL }}/oneclick/analyze-clause-and-design-queue
Autenticação: Bearer token (veja a seção de autenticação para mais detalhes)
Parâmetros da requisição: Headers
Authorization: Bearer {seu-token}
Content-Type: multipart/form-data
Corpo (multipart/form-data)
docx: Arquivo em formato Word (.docx) a ser processado (máximo de 10MB)
Campos de Query
| Campo | Tipo | Descrição |
|---|---|---|
|
ux_writing |
boolean |
Escolha se deseja aplicar o UX Writing ao documento. Envie true para aplicar o UX Writing ou false para manter o texto original. |
|
main_color |
string |
Cor principal do documento, em formato hexadecimal (por exemplo, #FF5733). Esta cor será usada como a cor principal no design do documento. |
|
logo_url |
string |
URL da logo do usuário. A logo deve estar em formato quadrado, não muito grande, com tamanho máximo de 1MB, e nos formatos PNG ou JPG. |
|
document_type |
string |
Tipo de documento enviado. Escolha um dos tipos da lista fornecida abaixo. O tipo de documento influencia o design aplicado. Veja a lista completa de tipos de documento mais abaixo. |
Tipo de documento:
Escolha o tipo de documento correto para garantir que o design seja aplicado adequadamente. Atualmente, nossa API trabalha melhor com contratos. Outros tipos de documentos podem não funcionar conforme esperado.
- Contrato de prestação de serviços/ fornecimento
- Contrato de locação
- Contrato de compra e venda
- Contrato de franquia
- NDA / Acordo ou Contrato de confidencialidade
- Contrato de trabalho
- Contrato para comercialização varejista
- Contrato de patrocínio
- Contrato de parceria
- Termo de rescisão / Distrato
- Contrato de opção de compra
- Contrato de mútuo conversível
- Contrato de doação
- Contrato de seguro
- Contrato de arrendamento
- Contrato de licença de uso de marca
- Contrato de Cessão de Direitos Autorais
- Contrato de Representação Artística
- Contrato de Transferência de Tecnologia
- Acordo de Acionistas
- Contrato de Cessão de Quotas
- Contrato de trespasse
- Contrato de hipoteca
- Contrato de fiança bancária
Requisitos para o arquivo do documento:
Formato: .docx
Tamanho máximo: 10MB
Estrutura: O arquivo deve conter apenas títulos, cláusulas e partes. Evite incluir os seguintes elementos:
- Header
- Rodapé
- Imagens
- Tabelas
- Partes de assinatura
- Sumário
- Capa
- Quadro resumo
- Fórmulas do Word
Siga o exemplo desse documento abaixo:
Download documento Word padrão UX DOC API.
Resposta da API
A resposta inicial indicará que o documento foi enviado com sucesso para a fila de processamento. O tempo médio de resposta é de aproximadamente 2 segundos. Após o processamento, o resultado será enviado para o Webhook configurado.
{
"reponse": {
"queue_id": string,
"created_at": Date,
}
}
Observações
Certifique-se de que o arquivo Word atende aos requisitos mencionados acima.
Consulte a seção de configuração de Webhook para saber como receber notificações quando o processamento estiver concluído.