• qui, 07/07/2022 - 16:11
  • /diego.lopes@sen...

APIs Privadas

As APIs Privadas são as APIs não liberadas oficialmente para utilização por clientes e parceiros da Senior Sistemas. Essas APIs são de uso interno e podem sofrer qualquer tipo de quebra de contrato, ou seja, podem sofrer alterações que façam com que integrações já existentes deixem de funcionar sem nenhum aviso prévio. Clientes e parceiros conseguem utilizá-las mas não é recomendado que as utilizem devido a instabilizade que podem representar. A Senior recomenda que clientes e parceiros utilizem apenas as APIs Públicas

Caso seja necessário realizar alguma alteração em uma primitiva privada que possa quebrar o contrato, como por exemplo a adição de um novo campo obrigatório numa requisição, a primitiva não receberá uma nova versão, a alteração será realizada na primitiva que está disponível no momento e isso poderá causar erros em integrações que estejam utilizando essa primitiva.

Assim como as APIs públicas, é necessário a utilização de um token válido para consumir as APIs Privadas. Elas não ficam abertas para a utilização por qualquer usuário protegendo assim a integridade dos dados.

Para visualizar a lista completa de APIs públicas da Senior, acesse: APIs Públicas

Para visualizar a lista completa de APIs privadas da Senior, acesse: APIs Privadas

Adição do path /private

Repare que a nova chamada para a API Privada possui o path /private na URL.

- https://api.senior.com.br/private/platform/workflow/saveProcessModel

O path /private foi adicionado a URL para ajudar os usuário a identificar mais facilmente uma primitiva privada. Dessa forma, deixamos explícito para o usuário que ele está utilizando uma API privada que que não é garantido a integridade dela.