FácilZap API
  1. FácilZap API
FácilZap API
  • FácilZap API
    • Introdução
    • Ambientes
    • Tipos de Usuários
    • Autenticação
    • Limites
    • Endpoints
    • Webhooks
    • Referência da API
    • Histórico de Alterações
  • Esquemas
    • Schemas
      • AbrirCaixaRequest
      • AdsCampanhaListagemResource
      • AdsCampanhaRequest
      • AssociacaoIntegracaoResource
      • AtualizarCashbackRequest
      • AtualizarConferenteRequest
      • AtualizarRevendedorRequest
      • AtualizarStoryRequest
      • BaixarXMLsNFesRequest
      • BrindeListagemResource
      • BrindeRequest
      • CaixaMovimentacaoListagemResource
      • CaixaFechamentoListagemResource
      • CaixaFechamentoResumoResource
      • CaixaListagemResource
      • CampanhaMensagemListagemResource
      • CaixaMovimentacaoRequest
      • CampanhaMensagemRequest
      • CaixaRequest
      • CategoriaListagemResource
      • CatalogoResource
      • CashbackListagemResource
      • ConferenteListagemResource
      • ClienteListagemResource
      • ConferidoPorResource
      • ClienteListagemBasicaResource
      • ClienteRequest
      • CriarCashbackRequest
      • ClientesCashbackListagemResource
      • CriarConferenteRequest
      • CriarRevendedorRequest
      • CriarCategoriaRequest
      • CriarStoryRequest
      • EstatisticasConferentesResource
      • CriarStoryViaProdutoRequest
      • EditarCategoriaRequest
      • DenunciaListagemResource
      • ContaContatoResource
      • EntidadeAutenticadaResource
      • ContaListagemResource
      • FecharCaixaRequest
      • ContaRecorrenciaListagemResource
      • FormaEntregaIntegradaResource
      • ContaRequest
      • FormaEntregaManualResource
      • ContaStatusRequest
      • FormaPagamentoManualResource
      • ContatoListagemResource
      • FornecedorListagemResource
      • ContatoRequest
      • FornecedorRequest
      • GrupoClienteListagemResource
      • GrupoClienteRequest
      • GuiaMedidasListagemResource
      • GuiaMedidasRequest
      • InutilizarNumeracoesNFeRequest
      • LojaListagemResource
      • NFCeRequest
      • NFeEmitenteCertificadoRequest
      • NFeEmitenteListagemResource
      • NFeEmitenteRequest
      • NFeFormaPagamentoListagemResource
      • NFeItemListagemResource
      • NFeListagemResource
      • NFeRequest
      • NFeStatusResource
      • NFeTerminalPagamentoListagemResource
      • NFeTerminalPagamentoRequest
      • PagamentoPedidoListagemBasicaResource
      • PedidoListagemBasicaResource
      • PedidoListagemResource
      • PedidoRevendedorListagemResource
      • ProdutoCodBarrasResource
      • ProdutoListagemBasicaResource
      • ProdutoListagemResource
      • PushMensagemListagemResource
      • PushMensagemRequest
      • RevendedorListagemResource
      • StoryListagemResource
      • VendedorResource
      • PedidoCodigoRastreioRequest
      • TokenRequest
    • Response
      • AuthenticationException
      • ValidationException
  1. FácilZap API

Autenticação

A FácilZap API utiliza Bearer Token para autenticação em todas as requisições. Isso garante que apenas usuários autorizados possam acessar os recursos da API. Siga os passos abaixo para obter e utilizar o token.

Passo a Passo para Obter o Token#

1
Acesse sua conta na plataforma FácilZap.
2
No menu lateral, clique em Integrações.
3
Clique no submenu FácilZap API.
4
Clique no botão Adicionar API Token para gerar um novo token de acesso.
5
Informe um nome para o Token e clique em Salvar.
6
Copie o token gerado e guarde-o em um local seguro.
Atenção
Por motivos de segurança, você não conseguirá ver o token novamente após fechar a janela. Copie-o e guarde em um local seguro.
Não compartilhe seu token com terceiros. Ele garante acesso total aos recursos da sua conta na API.

Utilizando o Token nas Requisições#

Após obter o token, você deve incluí-lo no cabeçalho de todas as requisições HTTP enviadas para a FácilZap API. O token deve ser utilizado da seguinte maneira:
Cabeçalho da Requisição (Header): Authorization: Bearer {seu_token_aqui}

Exemplo de Requisição#

Neste exemplo, a requisição GET ao endpoint /produtos usa o token para autenticar e obter os dados dos produtos cadastrados.

Expiração e Revogação de Tokens#

Os tokens não possuem um tempo de expiração, porém você pode revogá-los a qualquer momento:
1
Acesse sua conta na plataforma FácilZap.
2
No menu lateral, clique em Integrações.
3
Clique no submenu FácilZap API.
4
Encontre na lista o token que deseja revogar.
5
Clique no botão Remover e confirme.
Se você acredita que seu token foi comprometido, revogue-o imediatamente e gere um novo seguindo os passo a passos acima.
Modificado em 2024-10-26 20:38:56
Página anterior
Tipos de Usuários
Próxima página
Limites
Built with