Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  1. Pré-requisitos
    1. 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
    2. Plataforma com suporte REST e autenticação Basic.
    3. Suporte a a tratamento cross-domain, por conta das requisições de serviços em servidores de domínio diferente.

  2. Definições gerais
    1. 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 sucesso

      Mensagens 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"

      ...
      }