Domain Names:Visão geral da integração

Introdução à OpenAPI

O Alibaba Cloud disponibiliza o OpenAPI Explorer, uma plataforma que reúne busca de API, documentação, depuração online, geração de SDK, código de exemplo, diagnóstico de chamadas e estatísticas. O OpenAPI Explorer também gera códigos de exemplo de SDK para acelerar seu início. Para mais detalhes, consulte O que é a OpenAPI?.

Versões

A OpenAPI do Alibaba Cloud utiliza números de versão para gerenciar as APIs nas principais versões dos produtos. Atualmente, o Domain Names suporta a versão da API 2018-01-29. Este valor é um identificador de versão, não uma data. Ele garante acesso aos dados mais recentes da API pública, e a API pode ter recebido atualizações após 2018-01-29.

Depuração online

Para chamar uma API, é necessário conhecer sua versão, endpoint, estilo e métodos de chamada suportados.

Por exemplo, para utilizar a API SaveSingleTaskForCreatingOrderActivate (envie uma tarefa de registro de domínio), selecione a API desejada no painel de navegação à esquerda do OpenAPI Explorer. Na área central, selecione um endpoint, como China (Hangzhou), e insira os parâmetros da requisição. Esses parâmetros incluem os campos obrigatórios DomainName (o domínio que você deseja registrar), SubscriptionDuration (período de compra), RegistrantProfileId (ID do perfil do domínio), EnableDomainProxy (se deve ative a proteção de privacidade do domínio) e PermitPremiumActivation (se deve permitir o registro de um domínio premium). Em seguida, clique em Initiate Request. A descrição da API e a documentação dos parâmetros de requisição estão disponíveis no painel à direita.

Ponto de entrada para depuração

A página de depuração está disponível em: Página de depuração da API do Domain Names.

Endpoints

Para minimizar a latência, selecione o endpoint correspondente à região dos seus recursos.

Endpoint para Singapura: domain-intl.aliyuncs.com.

Estilo da API

Estilo RPC.

Identidade

Por padrão, o OpenAPI Explorer utiliza a identidade da sua conta Alibaba Cloud para realizar chamadas de API. Como essa conta possui acesso total à API, recomendamos fortemente a criação de um usuário RAM para acesso à API e operações diárias. Conceda ao usuário RAM as permissões necessárias do Domain Names antes de efetuar chamadas de API. Para mais informações, consulte Crie um usuário RAM para execute operações do Domain Names.

Mais informações

• Identidade, credenciais e autorização

• Limitação de taxa e gerenciamento de cotas

Métodos de integração

• SDKs do Alibaba Cloud

  • O Alibaba Cloud oferece SDKs para Java, C#, Go, Python, Node.js/TypeScript, PHP e C++. Os SDKs encapsulam a lógica de assinatura, o tratamento de tempo limite e a lógica de nova tentativa, além de fornecer objetos Request e Response para simplificar o desenvolvimento. Para mais informações, consulte Alibaba Cloud SDK.

  • Utilize o SDK do Domain Names para chamar a OpenAPI. Para obter detalhes sobre as linguagens suportadas e como instale dependências, consulte Exemplos de código do SDK para Java.

• Alibaba Cloud CLI

  • O Alibaba Cloud CLI permite execute comandos aliyun para interagir com os serviços do Alibaba Cloud e gerencie recursos de serviços em nuvem diretamente do seu terminal. Para mais informações, consulte O que é o Alibaba Cloud CLI.

  • Atualmente, o Alibaba Cloud CLI não suporta as APIs do Domain Names.

• Terraform

  • O Terraform é uma ferramenta de código aberto para visualize, provisionar e gerencie infraestrutura em nuvem, traduzindo modelos em chamadas de API. Para mais informações, consulte O que é o Alibaba Cloud Terraform?.

  • No momento, o Terraform não oferece suporte às APIs do Domain Names.

• Resource Orchestration Service (ROS)

  • O Resource Orchestration Service (ROS) automatiza o provisionamento de recursos em nuvem por meio de modelos. Você define os recursos necessários e suas dependências em um modelo, e o ROS os crie e configure automaticamente. Para mais informações, consulte O que é o Resource Orchestration Service.

  • O ROS ainda não suporta as APIs do Domain Names.

• Chamadas de API personalizadas

  • Para realizar chamadas HTTP nativas, implemente o algoritmo de assinatura, construa uma requisição personalizada e inicie a chamada HTTP. Para mais detalhes sobre o mecanismo de assinatura, consulte Estrutura e assinatura de requisição V3.

Observações de uso

• Caso uma chamada de API do Domain Names retorne um erro, utilize o código de erro para verifique se os parâmetros e valores da sua requisição estão corretos.

• Registre o ID da requisição presente na resposta ou na mensagem de erro do SDK e utilize a Plataforma de Diagnóstico da OpenAPI do Alibaba Cloud para diagnósticos de autoatendimento.