O que é a REST API da Transloadit?
A REST API da Transloadit é uma interface HTTP(S) para criar e gerenciar Assemblies e recursos relacionados, como Templates, credenciais de Template, informações de filas, dados de faturamento e tokens de autenticação. Ela pode ser chamada a partir de qualquer linguagem ou plataforma compatível, diretamente ou por meio de um SDK da Transloadit.
Como a REST API da Transloadit funciona
Um cliente HTTP cria uma Assembly enviando Instructions estruturadas e dados de autenticação a um endpoint do serviço e, em seguida, lê o Assembly Status e os identificadores retornados. A interface expõe recursos por meio de requisições e representações convencionais, sem exigir um ambiente de execução específico de uma linguagem. O processamento é assíncrono, por isso quem faz a chamada costuma combinar a resposta de criação com consultas periódicas ou Assembly Notifications. Seu lugar é na fronteira entre o código da aplicação e a infraestrutura de processamento de mídia da Transloadit.
Informações essenciais
- A integração direta via REST deixa a política de novas tentativas, os tempos limite, a validação das respostas e a construção de requisições multipart sob o controle da aplicação; um SDK pode encapsular muitos desses detalhes.
- A criação de uma Assembly pode incluir arquivos enviados por upload e Instructions em JSON em uma única requisição multipart, enquanto entradas importadas podem ser referenciadas pelos Steps de processamento.
- Uma requisição HTTP aceita não significa, por si só, que todos os Steps de mídia foram concluídos com sucesso; os clientes devem inspecionar os estados da Assembly e dos resultados antes de considerar as saídas completas.
Quando a REST API da Transloadit é importante
Use a REST API quando uma aplicação precisar de controle direto sobre a construção das requisições ou não tiver um SDK adequado. As requisições devem lidar corretamente com autenticação, serialização, erros de rede e respostas da API.