API#

A tela de API possui três abas:

  1. Swagger
    Nesta subseção, é aberta a documentação interativa da API. O usuário pode visualizar as solicitações disponíveis, seus parâmetros, a estrutura da resposta e usar o Swagger como referência para verificar integrações.
    A documentação também está disponível em: https://orchestrator.sherparpa.ru/api/docs/swagger.
  2. ReDoc
    Nesta subseção, é aberta uma representação alternativa da documentação da API.
    O ReDoc é conveniente para leitura: facilita a visualização das descrições dos métodos, esquemas de dados e campos obrigatórios das solicitações.
  3. Key
    Nesta subseção, o usuário gerencia a chave da API.
    Aqui é possível visualizar a chave atual, copiá-la ou gerar uma nova. Essa chave é usada para autorizar sistemas externos ao acessar a API do Sherpa Orchestrator.