Páginas filhas
  • Integração Força de Vendas - API

Versões comparadas

Chave

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

...

Expandir
titleIniciando

Nossas APIs são baseadas no protocolo HTTP E possui URLs previsíveis, é orientada a recursos e utiliza códigos de resposta HTTP para indicar sucesso ou erros e exceções.

As respostas (incluindo os erros) e o corpo das requisições são obrigatoriamente formatados em JSON.


Totvs custom tabs box
tabsSobre as requisições à API
idspasso1,passo2,

Os seguintes verbos HTTP estão disponíveis para uso:

VerboDescrição
GETSolicita dados de um recurso
POST

Cria um novo recurso

PUT

Atualiza um recurso

DELETEExclui um recurso
Totvs custom tabs box
tabsCabeçalho das requisições
idspasso2

O cabeçalho de requisição HTTP comumente usado é:

Accept: application/json

Content-Type: application/json

Deve-se obrigatoriamente especificá-los no header das requisições à API.



Expandir
titleAutenticação/Autorização
Utilizamos o Apache Shiro para identificar se a solicitação de acesso a API está autenticada, portanto apenas passar No Auth no Type Auth.


Expandir
titleURI Parameters
Totvs custom tabs box
tabsProcedimentos Iniciais
idspasso1,
Expandir




Autenticação/Autorização
Expandir
titleErros & Respostas
Expandir
titleURI Parameters

Utilizamos os códigos de resposta HTTP convencionais para indicar sucesso ou falha em uma solicitação à API.

  • Respostas de informação (100-199),
  • Respostas de sucesso (200-299),
  • Redirecionamentos (300-399)
  • Erros do cliente (400-499)
  • Erros do servidor (500-599).
title
Totvs custom tabs box
tabsProcedimentos Iniciais
idspasso1,