Projeto

Geral

Perfil

Defeito #381

Corrigir url base para a documentação da API

Adicionado por Mauricio Luiz Viani mais de 5 anos atrás. Atualizado mais de 5 anos atrás.

Situação:
Fechada
Prioridade:
Normal
Atribuído para:
Categoria:
API
Início:
08/11/2018
Data prevista:
% Terminado:

100%


Descrição

O caminho /docs da documentação da API está sendo formatado de forma incompleta, causando erro na exibição da página de documentação da API.

Realizar:
- Mudar para endereçamento relativo
- Criar entrada da urlbase no arquivo profileHomeServer.ini.template
- Eliminar comentários desnecessários
- Corrigir caracteres não representáveis por troca de conjunto de caracteres
- Melhorar identação de código em geral
- Remover o campo 'input text' de configuração do caminho da API que está na página index.php

Revisões associadas

Revisão 42d74e12
Adicionado por Alexandre Luiz Correia mais de 5 anos atrás

Issue #381 - Corrigido vários arquivos para apresentar a documentação da API corretamente.

Histórico

#1 Atualizado por Mauricio Luiz Vianimais de 5 anos

  • Descrição atualizado(a) (diff)

#2 Atualizado por Mauricio Luiz Vianimais de 5 anos

Alterar o texto "Sobre a API" conforme segue. Atualizações estão em MAIÚSCULO:

Esta API FORNECE RECURSOS PARA COMUNICAÇÃO COM sistemas e aplicativos externos. FOI desenvolvida utilizando o padrão REST e implementando o retorno dos dados ao consumidor utilizando o protocolo JSON-RPC de acordo com a especificação da versão 2.0. A API contém diversas funcionalidades e para cada uma delas é definido um recurso que pode receber parâmetros obrigatórios ou opcionais para o seu funcionamento.

ATRAVÉS DESTA DOCUMENTAÇÃO É POSSÍVEL INTERAGIR COM A API DO EXPRESSO, E TESTAR O ENVIO E RECEBIMENTO DE DADOS.

IMPORTANTE: SINTA-SE À vontade para desenvolver e realizar testes COM A API DO EXPRESSO, porém INFORME AOS ADMINISTRADORES DO EXPRESSO QUANDO SUA APLICAÇÃO ESTIVER RODANDO EM PRODUÇÃO, FACILITANDO AVISÁ-LO QUANDO UMA ATUALIZAÇÃO RELEVANTE FOR REALIZADA NA API.

COMO FUNCIONA A API

Para acessar um recurso da API, sua aplicação cliente deverá realizar uma requisição HTTP pelos métodos (GET,POST,PUT ou DELETE) para a URL_DA_API + NOME_DO_RECURSO, passando os parâmetros definidos nesta documentação. Cada recurso possui um conjunto de parâmetros (obrigatorios e/ou opicionais) que são necessários para atender as requisições enviadas ao servidor do Expresso.

A MAIORIA DOS RECURSOS NECESSITA DE AUTENTICAÇÃO PARA FUNCIONAR. A autenticação é feita ATRAVÉS DO recurso Login, PASSANDO-SE COMO PARÂMETROS o usuário e A senha. O LOGIN retornará uma chave de acesso (auth) que deverá ser enviada como parâmetro na chamada para os outros recursos.

Exemplo:

==================

AMBIENTE EXPRESSO

ESTÃO DISPONÍVEIS OS SEGUINTES AMBIENTES EXPRESSO, CADA QUAL COM A SUA API ESPECÍFICA:

#3 Atualizado por Alexandre Luiz Correiamais de 5 anos

  • % Terminado alterado de 0 para 80
  • Situação alterado de Nova para Resolvida

#4 Atualizado por Mauricio Luiz Vianimais de 5 anos

  • % Terminado alterado de 80 para 100
  • Situação alterado de Resolvida para Fechada

Exportar para Atom PDF