Conceitos básicos

Primeiramente, para começar a fazer uso do UOL Cloud Storage (bem como da API aqui documentada), você deve ter de antemão:

A API disponibilizada pelo UOL Cloud Storage é compatível com a API OpenStack (http://docs.openstack.org/api/openstack-object-storage/1.0/content/). Por ser baseada em REST e disponibilizada unicamente por meio do protocolo HTTP, o uso da API do OpenStack (e portanto a do UOL Cloud Storage) não depende do nenhuma linguagem de programação específica, de forma que a mesma pode ser acessada por meio de programas clientes devidamente construídos em qualquer linguagem de programação capaz de realizar requisições HTTP.

Existem bibliotecas já prontas para o protocolo OpenStack específicas para linguagens de programação populares, tais como C#/.NET, Java, PHP, Python e Ruby. Essas bibliotecas utilizam internamente a API REST do OpenStack e são feitas para ajudar os desenvolvedores integrar rapidamente as suas aplicações com os serviços de storage disponibilizados por meio da API REST OpenStack sem que eles necessitem lidar diretamente com os detalhes da interface REST e também abstraindo algumas das complexidades do protocolo OpenStack a fim de facilitar ainda mais o desenvolvimento. Cada uma destas bibliotecas inclui a sua própria documentação no formato nativo, como por exemplo, a biblioteca de Java inclui JavaDocs e a biblioteca de C#/.NET inclui o arquivo CHM. Uma vez que a API do UOL Cloud Storage é compatível com a API OpenStack, logo tais bibliotecas específicas de linguagem de programação podem ser utilizadas para acessar o UOL Cloud Storage.

Em geral um programa que utilize a API do UOL Cloud Storage deverá primeiramente efetuar a operação de autenticação informando a chave de acesso e a chave secreta, e caso a autenticação seja bem sucedida, receberá um token de acesso. As requisições subsequentes são realizadas informando-se o token de acesso recebido na etapa de autenticação. Entretanto, algumas operações simples (como por exemplo, o download de arquivos armazenados) não necessitam da etapa de autenticação.

No UOL Cloud Storage, todas as requisições são efetuadas para o host api.uolos.com.br, utilizando a porta TCP 80 para requisições HTTP e a porta TCP 443 para requisições HTTPS.

As seguintes restrições se aplicam as requisições HTTP da API REST do UOL Cloud Storage:

Nomes de container e de objetos devem ser codificados em UTF-8 e devem estar devidamente URL-encoded na invocação das operações REST do UOL Cloud Storage. Entretanto, normalmente as APIs HTTP e as APIs OpenStack presentes na maioria das linguagens de programação já fazem isso automaticamente.

Tal como é definido pelo padrão REST, os métodos HTTP a serem utilizados pela API seguem a seguinte regra:

Além disso, tal como definido pelo protocolo HTTP, respostas com códigos entre 200 e 299 indicam que a operação foi realizada com sucesso e respostas com códigos entre 400 e 499 indicam um erro.

Usando API REST

Recomentamos as seguintes extensões Chrome e Firefox para testes usando API REST:

1. Chrome - Advanced Rest Client:

2. Firefox - RESTClient: