FAQ

Esta separação de conteúdo tem por objetivo prestar um serviço mais adequado aos usuários de nossas APIs. Basicamente, pretende-se com este portal:

  • Centraliza os assuntos sobre APIs da plataforma senior X
  • Permitir o acompanhamento do uso destas APIs
  • Catalogar e conseguir prestar um atendimento mais apropriado aos desenvolvedores que utilizam as APIs da plataforma senior X
  • Permitir que a Senior consiga identificar problemas/necessidades, incluindo avisos de depreciação de APIs. A ideia é que a Senior consiga auxiliar o desenvolvedor a não ter sua integração/customização/implementação impactada por alguma mudança de contrato de API
  • Fornecer informações mais detalhadas do consumo das APIs por parte de seus clientes.

Não. O portal dev.senior continua existindo e ficará mais focado nos aplicativos (serviços) da X Platform. Assuntos como BPM, BOT, GED, Report, Analytics, etc. continuarão sendo referenciados e documentados nele.

O endereço https://api.senior.com.br é a porta de entrada adequada para os desenvolvedores que efetivamente estão consumindo APIs da plataforma senior X em suas implementações/customizações/integrações. Através deste endereço, você obterá todas as vantagens de saber como estão as chamadas das APIs nas suas soluções bem como será avisado sobre eventuais mudanças de contrato das APIs.

O endereço https://platform.senior.com.br é para ser utilizado pelos serviços internos e frontends da própria Senior. Não há como identificar o chamador da API de de uma maneira simples. Desta forma, o desenvolvedor não tem como saber como está o consumo de sua aplicação.

Além disso, a URL https://api.senior.com.br entrega os endpoints dos serviços de com um endpoint mais simplificado. Por exemplo, a API de autenticação quando é via platform.senior, tem a seguinte URL:
https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/platform/authentication/actions/login

Já a mesma API, quando invocada pelo endpoint específico das APIs públicas (api.senior), tem a seguinte URL:
https://api.senior.com.br/platform/authentication/login

Nossa sugestão é que você avalie a disponibilidade do serviço nas APIs públicas. A Senior se compromete a evitar ao máximo a quebra de contrato para as APIs expostas como APIs públicas. No entanto, as APIs que atender sob o platform.senior poderão sofrer alterações de contrato e depreciações sem aviso prévio.

Sugerimos que seja aberta uma solicitação de publicação do serviço/endpoint através do suporte da Senior. A solicitação será avaliada pelo produto indicando da possibilidade da publicação. Lembrando que isto não impede o uso da API (inclusive, pode ser a solução temporária), no entanto, eventuais alterações não serão avisadas e você não conseguirá obter estatísticas de uso desta API/endpoint.

O client_id é a chave que vai auxiliar tanto a Senior, quanto o próprio desenvolvedor que utiliza as APIs públicas da plataforma, a identificar a aplicação que está efetuando a chamada de uma API. Desta forma, caso ocorra alguma depreciação da API, conseguimos identificar a aplicação, bem como o proprietário desta, sendo possível avisá-lo e orientá-lo com antecedência.

Além disso, com este client_id, será possível consultar o consumo das APIs da plataforma senior X separados por aplicação (caso você tenha mais de uma).

Atualmente, o client_id não é obrigatório, mas deverá passar a ser a partir 2º quadrimestre de 2022.

Português, Brasil