OpenAPI como fonte
Métodos, caminhos e descrições de operação vêm do contrato OpenAPI para download.
Capacidade
Referência da API REST
Consulte a API para contas, Cloud, pastas, transformações, utilizadores e webhooks.
Descrição
A referência navegável é gerada pelo mesmo contrato OpenAPI 3.1.
OpenAPI 3.1
Transferir OpenAPI 3.1Referência da API REST
Consulte a API para contas, Cloud, pastas, transformações, utilizadores e webhooks.
| HTTP | Path | Descrição |
|---|---|---|
| GET | /auth/me | Devolve o utilizador autenticado e metadados seguros da chave API. |
| GET | /account | Devolve conta, reseller, subscrição e configuração Cloud efetiva. |
| PATCH | /account | Atualiza os dados básicos da conta. |
| GET | /account/stats | Devolve os totais de serviços, armazenamento, versões e visualizações. |
| GET | /cloud/settings | Devolve a configuração Cloud disponível para a função autenticada. |
| PATCH | /cloud/settings | Atualiza a configuração Cloud global ou a base das subcontas conforme a função. |
| GET | /cloud/catalog | Devolve o catálogo permitido de serviços, extensões e aplicações de carregamento. |
| GET | /cloud/services | Devolve uma lista paginada de serviços Cloud. |
| POST | /cloud/services | Cria um serviço Cloud editável. |
| POST | /cloud/files | Carrega um ficheiro após validar extensão, MIME detetado, tamanho e aplicação predefinida. |
| GET | /cloud/services/{code} | Devolve os detalhes de um serviço Cloud. |
| PATCH | /cloud/services/{code} | Atualiza nome, visibilidade, payload, pasta ou etiquetas. |
| DELETE | /cloud/services/{code} | Move um serviço Cloud para o lixo. |
| GET | /cloud/services/{code}/content | Descarrega com autenticação o ficheiro original ou um resultado. |
| GET | /cloud/services/{code}/thumbnail | Devolve Cloud serviços. |
| GET | /cloud/services/{code}/stats | Devolve visualizações, origens e atividade recente do serviço. |
| POST | /cloud/services/{code}/move | Move um serviço Cloud para outra pasta. |
| GET | /cloud/folders | Devolve as pastas acessíveis. |
| POST | /cloud/folders | Cria uma pasta. |
| PATCH | /cloud/folders/{id} | Muda o nome, move ou altera a visibilidade de uma pasta. |
| DELETE | /cloud/folders/{id} | Move uma pasta e o seu conteúdo para o lixo. |
| GET | /file-transformer/operations | Lista as 154 operações públicas com os respetivos formatos e parâmetros. |
| GET | /file-transformer/operations/{operation} | Devolve o contrato de uma operação específica. |
| POST | /file-transformer/estimates | Valida a entrada e estima os créditos antes da execução. |
| GET | /file-transformer/jobs | Devolve os trabalhos de transformação assíncronos da conta. |
| POST | /file-transformer/jobs | Cria e coloca uma transformação na fila. |
| GET | /file-transformer/jobs/{id} | Devolve estado, progresso, consumo e resultados de um trabalho. |
| POST | /file-transformer/jobs/{id}/cancel | Cancela um trabalho que ainda está na fila. |
| POST | /file-transformer/jobs/{id}/retry | Cria uma nova tentativa a partir de um trabalho falhado ou cancelado. |
| GET | /users | Os administradores listam utilizadores; os resellers listam as suas subcontas. |
| POST | /users | Cria um utilizador ou uma subconta. |
| GET | /users/{id} | Devolve os detalhes de um utilizador gerível. |
| PATCH | /users/{id} | Atualiza um utilizador gerível. |
| PATCH | /users/{id}/cloud-settings | Personaliza o Cloud para um utilizador gerível. |
| GET | /webhooks | Devolve os endpoints webhook da conta. |
| POST | /webhooks | Cria um endpoint webhook universal. |
| GET | /webhooks/{id} | Devolve os detalhes de um endpoint webhook. |
| PATCH | /webhooks/{id} | Atualiza URL, eventos ou estado, ou roda o segredo. |
| DELETE | /webhooks/{id} | Elimina um endpoint webhook. |
| POST | /webhooks/{id}/test | Coloca uma entrega de teste para o endpoint na fila. |
| GET | /webhooks/{id}/deliveries | Devolve o histórico paginado de entregas de um endpoint. |
| POST | /webhook-deliveries/{id}/retry | Volta a colocar manualmente uma entrega webhook na fila. |
| GET | /ai/providers | Lista IA fornecedores. |
| POST | /ai/estimates | Cria IA estimativas. |
| GET | /ai/text/generations | Lista IA texto gerações. |
| POST | /ai/text/generations | Cria IA texto gerações. |
| GET | /ai/media/generations | Lista IA multimédia gerações. |
| POST | /ai/media/generations | Cria IA multimédia gerações. |
| GET | /plans | Lista planos. |
| POST | /plans/custom/estimates | Cria planos personalizados estimativas. |
| GET | /billing/usage | Devolve faturação consumo. |
| GET | /billing/credit-consumptions | Lista faturação consumos de créditos. |
| GET | /billing/tariffs | Lista faturação tarifas. |
| GET | /billing/subscription | Devolve faturação subscrição. |
| POST | /billing/subscriptions/plan/{plan} | Cria faturação subscrições. |
| POST | /billing/subscriptions/custom | Cria faturação subscrições personalizados. |
| POST | /billing/subscriptions/{subscription}/renew | Renova faturação subscrições. |
| DELETE | /billing/subscriptions/{subscription} | Elimina faturação subscrições. |
| GET | /billing/transactions | Lista faturação transações. |
| GET | /billing/transactions/{id} | Devolve faturação transações. |
| POST | /billing/transactions/{id}/cancel | Cancela faturação transações. |
| POST | /billing/transactions/{id}/retry | Repete faturação transações. |
| POST | /billing/transactions/{id}/reconcile | Concilia faturação transações. |
| GET | /billing/invoices | Lista faturação faturas. |
| GET | /billing/invoices/{invoice} | Devolve faturação faturas. |
| GET | /billing/invoices/{invoice}/pdf | Devolve faturação faturas. |
| GET | /cloud/services/{code}/versions | Lista Cloud versões. |
| GET | /cloud/services/{code}/versions/{version}/download | Devolve Cloud versões. |
| POST | /cloud/services/{code}/versions/{version}/restore | Restaura Cloud versões. |
| GET | /cloud/services/{code}/permissions | Devolve Cloud serviços permissões. |
| PUT | /cloud/services/{code}/permissions | Atualiza Cloud serviços permissões. |
| GET | /cloud/folders/{folder}/permissions | Devolve Cloud pastas permissões. |
| PUT | /cloud/folders/{folder}/permissions | Atualiza Cloud pastas permissões. |
| GET | /cloud/imports/providers | Lista Cloud importações fornecedores. |
| GET | /cloud/imports/connections | Lista Cloud importações ligações. |
| GET | /cloud/imports/{provider}/authorization | Devolve Cloud importações autorização. |
| POST | /cloud/imports/{provider}/connections | Cria Cloud importações ligações. |
| DELETE | /cloud/imports/connections/{provider} | Elimina Cloud importações ligações. |
| GET | /cloud/imports/{provider}/browse | Devolve Cloud importações. |
| POST | /cloud/imports/{provider}/jobs | Cria Cloud importações. |
| GET | /cloud/import-jobs | Lista Cloud tarefas de importação. |
| GET | /cloud/import-jobs/{job} | Devolve Cloud tarefas de importação. |
| GET | /cloud/services/{code}/survey/responses | Lista Cloud inquérito respostas. |
| GET | /cloud/services/{code}/poll/results | Devolve Cloud votação resultados. |
| GET | /cloud/services/{code}/event/attendees | Lista Cloud evento participantes. |
| PATCH | /cloud/services/{code}/event/attendees/{attendee} | Atualiza Cloud evento participantes. |
| GET | /cloud/services/{code}/signature/tracking | Devolve Cloud assinatura acompanhamento. |
| GET | /marketplace/services | Lista marketplace serviços. |
| GET | /marketplace/services/{service} | Devolve marketplace serviços. |
| POST | /marketplace/services/{service}/installations | Cria marketplace instalações. |
| DELETE | /marketplace/services/{service}/installations | Elimina marketplace instalações. |
| POST | /marketplace/installations/{installation}/launch | Inicia marketplace instalações. |
| GET | /marketplace/partner/services | Lista marketplace parceiro serviços. |
| POST | /marketplace/partner/services | Cria marketplace parceiro serviços. |
| PUT | /marketplace/partner/services/{service} | Atualiza marketplace parceiro serviços. |
| DELETE | /marketplace/partner/services/{service} | Elimina marketplace parceiro serviços. |
| POST | /marketplace/partner/services/{service}/submit | Devolve marketplace parceiro serviços. |
Funcionalidades
O que Referência da API REST permite fazer
Autenticação com escopo
Cada operação protegida identifica o escopo de menor privilégio exigido por sua rota.
Tentativas de gravação seguras
As chaves de idempotência protegem as gravações suportadas contra duplicação acidental após novas tentativas de rede.
Transformações assíncronas
Crie, estime, monitore, cancele e tente novamente trabalhos do File Transformer.
Entrega de evento assinada
Crie endpoints de webhook, inspecione entregas e tente novamente falhas transitórias.
Escopo funcional explícito
Editores especializados, respostas a pesquisas, gerenciamento de participantes, assinaturas e geração de IA não estão implícitos, a menos que um endpoint seja listado.
Perguntas frequentes
Perguntas sobre Referência da API REST
Não. A referência é a lista oficial; o editor não listado e as operações específicas do serviço permanecem fluxos de trabalho da interface da conta.
Sim. O OpenAPI 3.1 JSON permanece disponível para geradores, validação e ferramentas locais.
Use uma chave de API com escopo restrito e uma chave de idempotência para operações de gravação compatíveis.