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
titleSobre as APIs

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.

Sobre as requisições à API

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

Cabeçalho das requisições

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

Accept: application/json

Content-Type: application/json

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

Autenticação/Autorização

Será necessário estar logado no sistema WTA.

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

...