O que preciso saber sobre a descontinuação da API Vapid?
Histórico
A partir de 1.º de fevereiro de 2021, a API Vapid do Procore foi descontinuada e substituída pela nova API Rest v1.0. A nova API (Interface de programação de aplicativos) é baseada em uma arquitetura atualizada e compatível com o controle de versão de recursos e funcionalidade expandida. Embora o Procore continue dando suporte para os recursos da API Vapid e corrigindo os problemas conforme necessário, todo o desenvolvimento de novos recursos para a API do Procore será feito no Rest v1.0. Embora seja improvável que essa alteração afete a maioria dos clientes do Procore, se você desenvolver e manter integrações personalizadas usando a API, recomendamos que leia este artigo para saber mais sobre como essa alteração pode afetar sua integração, bem como as etapas de migração para a nova API Rest v1.0.
Perguntas comuns
Qual a diferença da Rest v1.0 para a Vapid?
A Rest v1.0 é um superconjunto da API Vapid. Todos os endpoints de recursos disponíveis na Vapid também estão disponíveis na Rest v1.0 com a mesma funcionalidade.
Há novos recursos que posso acessar?
Fique atento às notificações do Procore Developer Portal sobre o lançamento de novos recursos da API Rest.
Há alterações importantes na Rest v1.0 que preciso levar em conta?
A Rest v1.0 não contém alterações significativas. A atualização de um aplicativo para usar a Rest v1.0 requer apenas a alteração das rotas que você está solicitando (p. ex., /vapid/projects passa a ser /rest/v1.0/projects).
Há alguma alteração no tratamento da autenticação?
Não. O endpoint de autenticação (p. ex., /oauth/authorize) permanece o mesmo na Rest, e os tokens de autenticação são compartilhados entre as duas APIs.
Como migro o código do meu aplicativo para a Rest v1.0?
A atualização de um aplicativo que está consumindo a API Vapid para usar a Rest v1.0 é muito simples: basta alterar as rotas que você está solicitando. Atualize sua integração para usar os recursos da Rest v1.0 alterando o formato dos URLs de endpoint da API em seu código para usar o novo namespace (/rest) e o parâmetro de versão (v1.0), conforme mostrado no exemplo abaixo.
/api.procore.com/vapid/projects
/api.procore.com/rest/v1.0/projects
Recomendamos testar seu código atualizado em sua sandbox de desenvolvimento para verificar se sua integração funcionará corretamente usando os endpoints de recurso /rest/v1.0.
Nova documentação do desenvolvedor da API Rest v1.0
Toda a documentação do desenvolvedor no Developer Portal foi atualizada com o lançamento da Rest v1.0. As páginas de referência para os recursos da API Rest v1.0 estão disponíveis na seção REFERÊNCIA do portal. Use o menu suspenso e selecione Rest v1 para acessar o novo conteúdo de referência.
Além disso, todos os guias de desenvolvimento de API, tutoriais e materiais relacionados na seção DOCUMENTOS do portal foram atualizados com o lançamento da Rest v1.0. Todos os trechos de código e amostras foram atualizados para refletir o novo formato de URL do endpoint.
Controle de versão de recursos da API Rest
A nova arquitetura de controle de versão da API Rest permite uma abordagem flexível para o gerenciamento de versões porque os recursos têm as versões controladas independentemente uns dos outros. Isso permite que você escolha se deseja adotar novas versões de recursos (com alterações importantes) ou permanecer com as que está usando. Use novas versões de recursos conforme elas forem lançadas e atualize seu código adequadamente, ou aguarde até que faça mais sentido para seu cronograma de desenvolvimento específico. Consulte Visão geral da API Rest para obter informações adicionais.
Registro de alterações da API Rest
O novo recurso de registro de alterações, também disponível no Developer Portal, permite visualizar detalhes sobre alterações em recursos individuais de API. Consulte Visão geral da API Rest para obter informações adicionais.