Tenho Interesse

Doc API REST SEMINOVAS

Documentação da API: Upload de Arquivo

Versão: 1.0.0 | Data: 10/01/2025

Esta API permite que você envie arquivos para um site WordPress e adicione informações como legenda (caption), texto alternativo (alt text) e descrição ao arquivo. O endpoint utiliza o mesmo namespace para todos os sites, mas o domínio e a chave de acesso podem variar conforme a configuração de cada site.

1. URL do Endpoint

O endpoint segue o formato abaixo, mas o domínio pode variar de acordo com o site onde a API está hospedada:

POST https://[dominio-do-site]/wp-json/meu_namespace/v1/upload-arquivo/

Exemplo de URL com o domínio “maxmoto.com.br”:

POST https://maxmoto.com.br/wp-json/meu_namespace/v1/upload-arquivo/

2. Autenticação

Este endpoint exige uma chave de acesso para autenticar a requisição. Para garantir que somente usuários autorizados possam realizar o upload, a chave de acesso deve ser passada como um parâmetro de consulta.

  • Parâmetro: chave
  • Valor esperado: [chave-configurada] (substitua pelo valor da chave configurada no código)

Exemplo de URL de requisição:

https://maxmoto.com.br/wp-json/meu_namespace/v1/upload-arquivo/?chave=[chave-configurada]

3. Parâmetros da Requisição

A requisição deve ser feita utilizando o método HTTP POST e os seguintes parâmetros devem ser passados:

Parâmetros Obrigatórios

  • arquivo: O arquivo a ser enviado. (Tipo: Arquivo)

Parâmetros Opcionais

  • caption: A legenda do arquivo. (Tipo: Texto)
  • alt_text: O texto alternativo da imagem. (Tipo: Texto)
  • description: A descrição do arquivo. (Tipo: Texto)

4. Exemplo de Requisição CURL

curl -X POST -F "arquivo=@D:/Arquivos/Sisand/515151.galeria-1.png" \
-F "caption=Imagem da galeria 1" \
-F "alt_text=Imagem de uma galeria com arte" \
-F "description=Uma imagem representando uma galeria de arte digital" \
https://maxmoto.com.br/wp-json/meu_namespace/v1/upload-arquivo/?chave=[chave-configurada]

5. Resposta da API

Após o upload, a resposta será em formato JSON, contendo informações sobre o arquivo carregado.

{
"message": "Arquivo carregado com sucesso!",
"attachment_id": 123,
"attachment_url": "https://maxmoto.com.br/wp-content/uploads/2025/01/515151.galeria-1.png"
}

Campos da Resposta:

  • message: Mensagem de sucesso ou erro.
  • attachment_id: ID do anexo na biblioteca de mídia do WordPress.
  • attachment_url: URL pública do arquivo carregado.

6. Códigos de Erro Comuns

Caso ocorra algum erro durante o processo de upload, a API retornará um código de erro e uma mensagem correspondente:

Chave de Acesso Inválida:
Código de erro: 403 Forbidden
Mensagem: Chave de acesso inválida.
Arquivo Não Enviado:
Código de erro: 400 Bad Request
Mensagem: Arquivo não enviado.
Erro no Upload:
Código de erro: 500 Internal Server Error
Mensagem: Detalhes sobre o erro, como "Erro no upload: Arquivo não permitido."

8. Considerações Finais

Segurança: A chave de acesso ajuda a proteger o endpoint contra acessos não autorizados.

Tipos de Arquivo Permitidos: O endpoint usa as configurações padrão do WordPress para validar os tipos de arquivos aceitos.

Personalização: Você pode ajustar o código conforme a necessidade para permitir diferentes tipos de arquivos ou adicionar novos metadados ao processo de upload.

Se houver mais perguntas ou ajustes necessários, estou à disposição!

▲
Rolar para topo

  • teste