Histórico da Página
...
- Pré-requisitos
- O modelo de implementação da API T-Reports foi criado seguindo o documento "Guia de implementação de API" disponível no link abaixo:
http://tdn.totvs.com/pages/viewpage.action?pageId=274849083 - Plataforma com suporte REST e autenticação Basic.
- Suporte a a tratamento cross-domain, por conta das requisições de serviços em servidores de domínio diferente.
- O modelo de implementação da API T-Reports foi criado seguindo o documento "Guia de implementação de API" disponível no link abaixo:
- Definições gerais
- Os retornos dos serviços REST devem estar encapsulados dentro de um objeto JSON com a seguinte especificação:
Mensagens de erro
Para todas as mensagens que representam um erro (códigos HTTP 4xx e 5xx) deve-se retornar obrigatoriamente os campos a seguir:
{
code:
"Código identificador do erro"
,
message:
"Literal no idioma da requisição descrevendo o erro para o cliente"
,
detailedMessage:
"Mensagem técnica e mais detalhada do erro"
}
Mensagens de sucessoMensagens de sucesso (código http 2xx devem) devem retornar diretamente a entidade que representa o objeto resultado da operação do endpoint. Ex:
GET http:
//totvs.com.br/api/trep/v1/dataproviders/1
{
code:
"0001"
,
description:
"provedor de DB"
...
}
- Os retornos dos serviços REST devem estar encapsulados dentro de um objeto JSON com a seguinte especificação:
- Descrição dos serviços
Os serviços REST descritos a seguir estão divididos em:
- Serviço de leitura de parâmetros gerais;
- Serviço de teste de conexão;
- Serviço de teste de sentença sql;
- Serviço de leitura de schema de tabelas fisicas;
- Serviço de leitura de schema de sentença sql;
- Serviço de retorno de dados;
Na descrição de cada serviço podemos encontrar os seguintes elementos:
- Definição da URL do serviço;
- Parâmetros de request (entrada) e response (saída);
- Descrição do serviço com detalhes relativos ao seu funcionamento;
- Exemplos de uso.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas