As operações da API Admin são mapeadas diretamente para os verbos HTTP do REST, significando que os métodos HTTP padrão são usados para recuperar e manipular seus recursos.
Os formatos específicos para os URIs da API Admin são:
https://appengine.googleapis.com/v1/resourcePath?parameters
Por exemplo, para listar todos os detalhes sobre a versão my-v1 no serviço my-
frontend do aplicativo no projeto my-app, envie a solicitação
HTTP com o parâmetro ?view=FULL:
GET https://appengine.googleapis.com/v1/apps/my-app/services/my-frontend/versions/my-v1?view=FULL
Para ver o conjunto completo de URIs usados para cada operação compatível na API, consulte o documento de referência da API Admin do Google App Engine.
Noções básicas
Você é um novo usuário das APIs REST? A seguir estão alguns recursos para ajudar você a começar.
Fundamentos do REST
Há duas maneiras de chamar a API:
- Enviar solicitações HTTP e analisar as respostas.
- Usar as bibliotecas de cliente
Se você não quiser usar as bibliotecas de cliente, precisará entender os fundamentos do REST.
REST é um estilo de arquitetura de software que fornece uma abordagem conveniente e consistente para solicitar e modificar dados.
O termo REST é a abreviação de "Representational State Transfer (Transferência de Estado Representacional)". No contexto das APIs do Google, ele se refere ao uso de verbos HTTP para recuperar e modificar representações de dados armazenados pelo Google.
Em um sistema RESTful, os recursos são mantidos em um armazenamento de dados. Um cliente envia uma solicitação para que uma ação específica seja executada no servidor, como a criação, recuperação, atualização ou exclusão de um recurso. Essa ação é executada e uma resposta é enviada, geralmente no formato de uma representação do recurso especificado.
Nas APIs RESTful do Google, uma ação é especificada no cliente usando um verbo HTTP como POST, GET, PUT ou DELETE. Um recurso é definido por meio de um URI global exclusivo no seguinte formato:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Como todos os recursos da API têm URIs exclusivos acessíveis por HTTP, a REST permite o armazenamento em cache dos dados e é otimizada para funcionar na infraestrutura distribuída da Web.
As definições de método (em inglês) encontradas na documentação dos padrões HTTP 1.1 podem ser úteis. Nelas estão incluídas as especificações GET, POST, PUT e DELETE.
Fundamentos sobre o JSON
A API Admin retorna dados no formato JSON.
JSON (JavaScript Object Notation) é um formato de dados comum e independente de linguagem que oferece uma representação de texto simples das estruturas de dados arbitrárias. Para mais informações, acesse json.org (em inglês).