Alternativa B - The version number is embedded in the API endpoint URL, such as v1 or v3.
Análise da Questão
Esta questão aborda conceitos de integração via API, especificamente relacionada à arquitetura da HubSpot API (identificada pela menção a "hubapi" nas opções). Para responder corretamente, é necessário entender como as versões de uma API são estruturadas e identificadas em requisições HTTP.
Conceitos-Chave
- Endpoint URL (URL do Endpoint): É o endereço completo ou relativo que define a ação específica dentro da API (ex:
/crm/v3/objects). - Versionamento de API: Prática de manter diferentes versões de um serviço para garantir compatibilidade. As versões mais comuns são indicadas por números como
v1, v2, v3. - Estrutura HubSpot: Na documentação oficial da HubSpot, a versão da API geralmente aparece na rota do caminho (path) da URL.
Justificativa Didática
A alternativa correta é a segunda opção (B), pois descreve a prática padrão de versionamento utilizada pela HubSpot e muitas outras APIs REST modernas.
- Por que a Alternativa B está correta?
- Nas chamadas à API da HubSpot (especialmente na versão pública atual), o número da versão é inserido diretamente no caminho do endpoint.
- Exemplo prático: Uma chamada para criar um contato na versão 3 segue o formato
https://api.hubapi.com/crm/v3/objects/contact. - Note que o segmento
v3 está explícito na URL do endpoint, permitindo identificar facilmente qual versão está sendo utilizada antes mesmo de enviar os dados. - Por que as outras alternativas estão incorretas?
- Opção A (Query Parameter): Embora algumas APIs permitam versionamento via parâmetros de consulta (ex:
?version=1), não é o método primário ou padrão indicado para encontrar a versão da chamada na estrutura da HubSpot. - Opção C (Base URL): Esta opção sugere que a versão muda o domínio principal (ex:
api.v3.hubapi). Embora seja uma estratégia válida de versionamento (Subdomain Versioning), a HubSpot utiliza predominantemente o mesmo domínio base (api.hubapi.com), mudando apenas a rota interna. - Opção D (Response Body): Tentar descobrir a versão apenas após receber a resposta é ineficiente e arriscado. Você precisa saber a versão antes de fazer a chamada para construir a URL correta e evitar erros de incompatibilidade.
Conclusão
Para identificar a versão da API ao realizar uma integração, deve-se observar a estrutura da URL de destino. O número da versão (como v1 ou v3) é parte integrante do endpoint URL, facilitando a manutenção e o versionamento dos serviços.