Visão geral da plataforma
A API OmniDoc gerencia fluxos de trabalho de arquivos e conteúdos dentro de uma única conta. Um solicitante cria recursos com uma chave de API e, em seguida, utiliza os IDs estáveis retornados para consultar, combinar, processar ou baixar esses recursos.
Modelo de recurso
Seção intitulada “Modelo de recurso”| Recurso | Propósito |
|---|---|
| Documento / Arquivo | Arquivos de origem e entradas da biblioteca de arquivos pertencentes à conta |
| Trabalho / Operação | Tradução assíncrona, processamento de documentos ou tarefas de áudio e vídeo |
| Artefato | Resultados que um trabalho entrega para pré-visualização ou download |
| Operação de crédito | O registro de qual ação faturável foi cobrada e reembolsada |
Cada recurso é verificado em relação à conta proprietária. Os clientes precisam manter apenas os IDs públicos e não devem inferir detalhes de implementação a partir de IDs, nomes de arquivos ou endereços de download.
Fluxo de chamada comum
Seção intitulada “Fluxo de chamada comum”- Crie ou escolha um recurso de entrada.
- Certifique-se de que a conta tenha créditos: o saldo é verificado em relação a um limite antes do início da tarefa, e o uso efetivo é cobrado ao final.
- Crie o trabalho com um
Idempotency-Key. - Verifique o status do trabalho; trabalhos de tradução de arquivos também podem usar SSE ou webhooks.
- Leia os resultados e o registro de crédito deste trabalho.
Identidade
Seção intitulada “Identidade”Integrações externas sempre utilizam chaves de API, com as mesmas permissões da conta que criou a chave. Consulte autenticação .
Início rápido → Carregue um arquivo, crie uma tarefa, verifique seu status e baixe os resultados