Bem-vindo ao Portal API Petros!

Para ter acesso a todas as funcionalidades e recursos disponíveis, é necessário realizar um cadastro em nosso portal. O processo de cadastro é simples e seguro, garantindo a proteção de suas informações pessoais e a melhor experiência de uso.

Faça agora mesmo o seu cadastro clicando aqui!

API Docs

O API Docs é uma seção essencial e abrangente dentro do portal, projetada para fornecer aos usuários todas as informações necessárias para entender, explorar e utilizar as APIs disponíveis.

Nessa seção, você encontrará as funcionalidades Documentações e Catálogo de APIs, que são recursos-chave para o seu sucesso na integração de APIs.

Documentações

A seção Documentações é uma ferramenta essencial dentro do API Docs, pois é nesse espaço que os usuários podem acessar e explorar todas as documentações funcionais das APIs disponíveis.

Nela, você encontrará uma vasta coleção de materiais informativos e orientações detalhadas sobre o uso e o funcionamento das APIs.

As documentações desempenham um papel fundamental ao fornecer um guia completo sobre como utilizar cada API específica. Elas fornecem instruções claras e precisas sobre os endpoints, parâmetros, tipos de dados aceitos, formatos de resposta e qualquer autenticação necessária para interagir com a API.

Ao acessar a seção de Documentações, você encontrará um conjunto de recursos cuidadosamente elaborados para auxiliá-lo a entender o propósito, a funcionalidade e as melhores práticas para implementar a API em seu projeto.

As documentações são projetadas de forma a oferecer explicações detalhadas, exemplos de código e fluxos de trabalho para facilitar a compreensão e a aplicação prática das APIs.

Seja você um desenvolvedor iniciante ou experiente, as documentações fornecem um ponto de partida valioso para aprender sobre as APIs disponíveis. Elas permitem que você descubra as capacidades e os recursos oferecidos por cada API, além de fornecer insights sobre as possíveis integrações e casos de uso relevantes.

Catálogo de APIs

O Catálogo de APIs oferece uma variedade de recursos para os usuários. Com ele, você pode consultar APIs que estão publicamente disponíveis ou abertas para uso.

Uma funcionalidade interessante é a capacidade de baixar o Swagger, que é uma especificação de API em formato JSON, permitindo uma análise detalhada das informações fornecidas pela API.

Você também pode analisar as informações na própria tela, facilitando a visualização e compreensão das funcionalidades oferecidas pela API. Através da botão Ver.

Outro recurso útil é o acesso ao Redoc, que é uma ferramenta de documentação interativa para APIs. Com o Redoc, você pode explorar a documentação da API de forma amigável e intuitiva. Além disso, você pode simular uma solicitação POST diretamente no Redoc. Basta utilizar a opção 'TRY' para testar e verificar o funcionamento dessa operação.

Em resumo, o API Browser oferece um catálogo de APIs com recursos como consulta de APIs públicas e abertas, visualização das APIs enviadas pelo Sensedia Manager, download do Swagger para análise detalhada, acesso ao Redoc para explorar a documentação interativa e a possibilidade de simular solicitações POST no Redoc. Essas funcionalidades proporcionam uma experiência completa e facilitam o uso e a compreensão das APIs disponíveis.

DevTools

A seção DevTools é um conjunto de ferramentas avançadas e recursos poderosos dentro do portal, projetados especificamente para atender às necessidades dos desenvolvedores.

É um espaço dedicado para ajudar os desenvolvedores a otimizar, monitorar e gerenciar suas integrações com as APIs de forma eficiente.

Minhas APPs

É uma funcionalidade essencial do portal que oferece aos usuários a capacidade de gerenciar suas próprias aplicações de maneira conveniente.

Essa seção permite criar credenciais específicas para consumir as APIs disponíveis e também oferece a possibilidade de consultar todas as apps associadas ao usuário.

Além disso, a funcionalidade Minhas APPs permite consultar e visualizar todas as aplicações associadas à sua conta de usuário. Essa lista fornecerá informações detalhadas sobre cada aplicação, como o nome, a descrição e as permissões concedidas.

Essa visão geral das suas apps facilita o gerenciamento e a organização, permitindo que você tenha um controle completo sobre as aplicações

Dev Dashboard

O Dev Dashboard é uma funcionalidade poderosa do portal que oferece aos desenvolvedores uma visão abrangente e detalhada das chamadas feitas nas APIs.

Nessa seção, é possível visualizar e explorar as informações relacionadas às chamadas realizadas, além de ter acesso aos detalhes específicos de cada chamada.

Para que os dados apareçam no Dev Dashboard, é necessário fazer chamadas nas APIs disponíveis. Cada chamada realizada é registrada e exibida de forma clara e organizada no painel.

Essa funcionalidade permite que os desenvolvedores acompanhem e analisem as interações com as APIs em tempo real, facilitando o processo de depuração e otimização.

Ao acessar o Dev Dashboard, você terá acesso não apenas ao registro das chamadas, mas também a informações detalhadas sobre cada uma delas. Esses detalhes incluem a URL da chamada, os parâmetros utilizados, os cabeçalhos enviados e as respostas recebidas da API. Essa visão detalhada das chamadas permite uma análise minuciosa e um melhor entendimento do comportamento e desempenho das APIs utilizadas.

Um aspecto fundamental do Dev Dashboard é a segurança dos dados. Todos os dados sensíveis relacionados às chamadas, como chaves de API ou tokens de acesso, são criptografados para garantir a proteção e a confidencialidade das informações.

Essa abordagem garante a integridade dos dados e mantém a segurança durante o processo de visualização e análise das chamadas.

Além disso, o Dev Dashboard mantém um histórico completo das chamadas realizadas. Esse histórico permite que você acompanhe o registro de todas as interações anteriores, fornecendo um rastreamento completo e uma referência útil para análises retrospectivas.

Com essa funcionalidade, você pode revisitar chamadas anteriores, examinar resultados e identificar padrões ou tendências relevantes.

API Status

A funcionalidade API Status no portal oferece informações valiosas sobre o status e o desempenho das APIs em tempo real.

Com essa ferramenta, você pode obter insights sobre as operações mais frequentemente chamadas naquele momento, bem como informações sobre a duração do uso da API.

Ao acessar a seção API Status, você encontrará uma seção dedicada a análises, onde é possível visualizar as Top Operations ou as 15 operações mais chamadas naquele momento.

Essas informações fornecem uma visão imediata das operações que estão sendo amplamente utilizadas pelos usuários no momento atual. Essa visão em tempo real permite que você identifique quais operações são as mais populares e possam ser consideradas de maior relevância no momento.

Além disso, a funcionalidade API Status também pode fornecer informações sobre o tempo de uso da API. Essa métrica é valiosa para entender a estabilidade e a confiabilidade da API, bem como sua maturidade no mercado.

O tempo de uso da API indica há quanto tempo ela está disponível para os usuários, oferecendo uma medida de sua experiência e estabilidade.

Ao conhecer as operações mais chamadas e o tempo de uso da API, você pode tomar decisões informadas sobre o uso e a integração dessas APIs em seus projetos.

As operações mais populares podem indicar recursos-chave ou funcionalidades com maior demanda, permitindo que você alinhe suas estratégias de desenvolvimento e integração de acordo com as necessidades dos usuários.

Validador de Swagger

A ferramenta Validador Swagger valida um arquivo swagger no portal desenvolvedor.

O serviço verifica o arquivo para garantir que esteja adequado e, cumpra nossos requisitos e diretrizes de construção e documentação de APIs.

Será apresentada uma tabela para ajudar a localizar e corrigir erros. A tabela lista eventuais erros que a ferramenta pode gerar, e para cada erro, ha uma solução correspondente. As soluções listadas podem ajudar voce a evitar erros antes ou ao longo da solicitação de implantação do serviço no API Gateway Sensedia.