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.

...

Sobre as requisições à API

ids

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

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
tabspasso1,passo2,
VerboDescrição
GETSolicita dados de um recurso
POST

Cria um novo recurso

PUT

Atualiza um recurso

DELETEExclui um recurso
Totvs custom tabs boxtabs


Cabeçalho das requisições

ids

passo2

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.

expand

titletitle


Autenticaçã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


Erros & Respostas

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).


URI Parameters

Alguns recursos disponibilizados podem oferecer a possibilidade de utilização de “URI Parameters” amigáveis.
Os parâmetros quando disponíveis são:

• filter - Habilita filtragem (consulta) de resultados.

Expandir
titleEndpoints
Expandir
titleApi Cliente


Expandir
titleApi pedi