Skip to main content
A YCloud usa versões de URI para alterações significativas da API. A URL base atual da API é https://api.ycloud.com/v2.

​
Alterações compatíveis com versões anteriores

Sua integração deve tolerar estas alterações dentro da mesma versão da API:
  • Novos recursos de API.
  • Novos parâmetros opcionais de solicitação em operações existentes.
  • Novas propriedades de resposta ou uma ordem diferente das propriedades de resposta.
  • Alterações no comprimento ou formato de strings opacas, incluindo IDs de objetos, mensagens de erro e outras strings legíveis por humanos.
  • Novos valores de enum, incluindo novos tipos de eventos de Webhook.
Ignore propriedades de resposta que você não utiliza. Lide com tipos de eventos desconhecidos sem causar falhas em todo o receptor de Webhook. Use códigos de erro documentados para o fluxo de controle em vez de comparar mensagens de erro legíveis por humanos.

​
Armazene identificadores opacos

Trate os IDs de objetos como strings opacas e que diferenciam maiúsculas de minúsculas. Não deduza significados a partir do tamanho de um ID ou de um prefixo como evt_; prefixos podem ser adicionados ou removidos. IDs de objetos gerados pela YCloud não excedem 255 caracteres. Reserve esse tamanho total em seu armazenamento. Por exemplo, uma coluna MySQL pode usar VARCHAR(255) COLLATE utf8_bin para preservar comparações que diferenciam maiúsculas de minúsculas.

​
Alterações significativas (breaking changes)

Uma alteração significativa utiliza uma versão diferente na URI da solicitação. Por exemplo:
Use a versão documentada para a sua integração. Não altere o segmento de versão sem verificar os contratos de solicitação, resposta e Webhook. Consulte o registro de alterações da API para ver o histórico de alterações.