CDN - Guia da API  Imprimir este Artigo

CDN - GUIA DA API

A API permite a integração na nuvem com aplicativos de terceiros. Este guia é uma referência completa para todas as chamadas de API e inclui informações detalhadas da API, exemplos de código e saída. A versão do guia corresponde à versão mais recente da API OnApp.

A API OnApp é RESTful

Todas as chamadas de função respondem aos formatos de troca XML e JSON

Todas as chamadas de função precisam de autorização e autenticação (HTTP básico ou chave de API)

A API OnApp é compatível com versões anteriores em uma versão principal. No entanto, uma nova versão principal pode incluir alterações que não são compatíveis com a anterior.

Autenticação de API

Para autenticar usando HTTP Basic, basta usar sua combinação de nome de usuário / senha. Curl exemplo:

curl -u user: userpass

Para autenticar usando a chave de API, coloque o email da sua conta como um login e a chave do servidor como uma senha.

Métodos HTTP

A API usa os seguintes métodos HTTP:

GET - usado para recuperar informações de um determinado URI

POST - usado para criar novo objeto e adicionar novas transações na fila

PUT - usado para alterar as propriedades do objeto

* OBSERVAÇÃO: o valor updated_at é alterado nas solicitações PUT, mesmo se a solicitação falhar.

DELETE - usado para exclusão de objetos

 

Códigos de Resposta HTTP

A API retorna códigos de status HTTP apropriados para cada solicitação:

200 OK: O pedido foi concluído com sucesso

204 No Content: A solicitação foi concluída com sucesso. O status 204 é retornado em solicitações DELETE e PUT

201 Scheduled:  A solicitação foi aceita e agendada para processamento

403 Forbidden: A solicitação está correta, mas não pôde ser processada.

404 Not Found: O URL solicitado está incorreto ou o recurso não existe. Por exemplo, se você solicitar a exclusão de um usuário com o ID {5}, mas não houver esse usuário na nuvem, você receberá um erro 404.

422 Unprocessable Entity: Os parâmetros enviados estão errados.

500 Internal Server Error: Ocorreu um erro. Por favor entre em contato com o suporte.

 

503 Service Unavailable: O pedido não pode ser tratado atualmente, devido a uma sobrecarga ou manutenção temporária do servidor. Esta condição é temporária e a solicitação será entregue após um certo atraso.

Convenções de Formatação e Nomenclatura

 

A tabela abaixo representa todas as convenções de formatação e nomenclatura existentes usadas neste guia:

 

usuário:userpass - Significa nome de usuário:combinação de senha - Admin:123456

onapp.test - Significa endereço, onde seu Painel de Controle está localizado - Example.com

: id - Significa o ID do recurso.Às vezes também::resource_id - 23

italics - Todos os parâmetros estão em itálico - currency_code

* (asterisk) - Marca o rótulo dos parâmetros - label*

preformatted - Indica exemplos de solicitação em XML ou JSON - GET/roles.xml

Bloco de código (Code Block) indica solicitações de console e exemplos de resposta.

info - Uma mensagem informativa enfatiza ou explica as informações contidas no capítulo. - Clicar no botão OFF executa um desligamento normal e, em seguida, desliga o VS.

note - Observação Uma mensagem de observação contém informações essenciais para a conclusão da tarefa. - O comprimento máximo de um ponto de montagem é de 256 caracteres.

aviso - Uma mensagem de aviso informa você sobre algo que você não deve fazer ou seja cauteloso. - Você não poderá restaurar um VS após excluí-lo.

 

(*) - O elemento que mostra novos parâmetros adicionados na última versão da API. - (*) limit_type - tipo de limite por hora ou mensal, definido para o recurso.

Perguntas frequentes

P: É possível ativar o acesso à API via https?

R: Podemos habilitar https para sua nuvem, que pode ser usada para acesso à WebUI e acesso à API. Ou você pode fazê-lo: o arquivo de configuração do Apache está localizado em: /etc/httpd/conf.d/onapp.conf

P: Você pode criar um VS em nome de outro usuário?

R: Não. É possível trocar os proprietários do VS, no entanto. Consulte a seção Alterar proprietário do VS para obter detalhes.

P: Como as senhas são armazenadas - em texto simples?

R: Não, as senhas não são armazenadas em texto simples. Com exceção de uma combinação de login e senha, você pode usar a combinação de chaves e-mail + API para autorizar um usuário por meio da API. As chaves de API podem ser geradas e alteradas facilmente na página de perfil de um usuário (bem como por meio da API). Por razões de segurança, recomendamos que os usuários se autentiquem por meio da chave da API, não o login e a senha.

P: Quais parâmetros são necessários e quais são opcionais?

R: Os parâmetros necessários estão marcados neste guia com um asterisco *.

 

Esta resposta lhe foi útil?

Artigos Relacionados

CDN - Configuração
CDN – Configuração Via Painel CL9   Conforme explicado em artigo anterior, já sabemos...
CDN - VoD - Live Streaming - Conceitos
CDN - Content Delivery Network   CDN é abreviação de Content Delivery Network (ou Rede de...
Criar Recurso CDN HTTP
  Criar Recurso CDN HTTP Para adicionar um recurso HTTP CDN: Vá para o menu Recursos do CDN do...
CDN - Instruções de Upload
  Instruções de upload Aqui está a lista de instruções para o upload de arquivos e incorporação...
Recurso CDN
  Recursos Um recurso CDN é um host (por exemplo, um servidor da Web específico), cujo...