Versões
Descobre as versões dos endpoints públicos do GO.
Todos os endpoints públicos do GO são versionados pois destinam-se a consumo externo, permitindo o desenvolvimento de novas funcionalidades sem comprometer a compatibilidade com sistemas que dependem das estruturas de dados de versões anteriores.
Uma vez que todas as respostas são JSON, adicionar novas propriedades aos endpoints não é considerado uma alteração significativa, pois estas propriedades podem ser ignoradas com segurança pelos consumidores. Portanto, nesses casos, a versão pode não ser alterada. Esta abordagem parece-nos equilibrada pois permite-nos introduzir melhorias mais rapidamente enquanto minimizamos o impacto nas integrações existentes.
APIs Carris Metropolitana
O API da Carris Metropolitana foi pioneiro na medida em que disponibilizou, de forma livre e transparente, toda a informação da rede de transportes, em tempo real, com tempos de atualização excelentes. O API da CM já passou por várias iterações tendo estabilizado na sua segunda versão, que na verdade é a terceira. Estes endpoints irão manter-se operacionais e atualizados enquanto fizer sentido, não existindo planos para os descontinuar no médio prazo.
| API | Versão | Status | Fim de Vida | Devo utilizar? |
|---|---|---|---|---|
| CM Schedules API | experimental | Discontinued | Late 2023 | ❌ |
| Carris Metropolitana API | v1 | Deprecated | Late 2026 | ❌ |
| Carris Metropolitana API | v2 | Active | - | ✅ |
GO Hub API
O API do GO é a continuação lógica do API da CM, agora com mais operadores. Esta evolução internaliza as aprendizagens dos últimos anos e, com uma infraestrutura mais robusta, permite-nos oferecer uma melhor experiência com dados de melhor qualidade num único lugar. É no Hub que iremos focar os nossos esforços a partir de agora, pelo que recomendamos a utilização destes endpoints.
No GO estamos também mais aptos a manter separadas e estanques as versões dos endpoints. Queremos fornecer um serviço de qualidade, confiável quer pela rapidez e alta disponibilidade das respostas quer pela continuada manutenção de endpoints mais antigos.
| API | Versão | Status | Devo utilizar? |
|---|---|---|---|
| GO Hub API | v1 | Active | ⌛ |
Importante
O desenvolvimento do GO Hub API está em fase de conclusão — ainda estamos a trabalhar para estabilizar as estruturas das respostas assim como na garantia de uma disponibilidade consistente do serviço. Sugerimos aguardar até que esta versão 1 do API seja considerada concluída para a sua utilização em segurança em ambientes de produção.
APIs autenticados
Os restantes endpoints autenticados do GO não são versionados. Esta é uma decisão que tomámos para permitir maior agilidade no desenvolvimento dos sistemas. A grande maioria dos endpoints requer autenticação e é utilizada apenas para a própria aplicação de frontend. A estrutura em monorepo, preview environments, deploys automáticos, kubernetes, e a própria natureza web do projeto, permite-nos manter o frontend e o backend sincronizados e atualizados.