CloudInvoice API - Docs
Voltar ao InícioPreços e PlanosContacte-nos
  • Introdução
    • Começar a Utilizar
    • Autenticação
    • Exemplos de Pedidos
    • Erros e Respostas
    • Precisa de Ajuda?
    • Change Log
  • Conta / Autenticação
    • Login
    • Login - Sandbox
    • Planos Demo
    • Info do User
    • Empresas
  • Documentação API
    • Documentos
      • List
        • Vendas - List
        • Guias - List
        • Stocks - List
        • Outros Documentos - List
      • Create
      • Get
      • Finalize
      • Annul
      • Print
      • Email
      • Delete
      • Emit - Nota de Crédito
      • Linhas - List
      • Pagamentos - List
      • Apêndice
    • Tipos de Documentos
      • List
      • Get
    • Séries de Documentos
      • List
      • Get
    • Clientes
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
    • Fornecedores
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
    • Produtos
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
      • Stock Geral - List
      • Stock Geral - Get
      • Stocks por Armazém - List
      • Stocks por Armazém - Get
      • Preços de Venda - List
      • Preços de Venda - Get
      • Preços de Venda - Update
      • Códigos Alternativos - List
      • Código Alternativo - Get
      • Código Alternativo - Create
      • Código Alternativo - Update
      • Código Alternativo - Delete
    • Famílias
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
    • Sub-Famílias
      • List
      • Create
      • Update
      • Get
      • Seek
      • Exists
      • Delete
    • Taxas
      • List
      • Get
    • Motivos de Isenção
      • List
      • Get
    • Linhas de Preços
      • List
      • Get
    • Unidades de Medida
      • List
      • Get
    • Métodos de Pagamento
      • List
      • Get
    • Condições de Pagamento
      • List
      • Get
    • Países
      • List
      • Get
    • Distritos
      • List
      • Create
      • Get
      • Seek
      • Exists
      • Update
      • Delete
    • Concelhos
      • List
      • Create
      • Get
      • Update
      • Delete
    • Relatórios
      • List
      • Create
    • Apêndice
  • Outros Links
    • Ir para /V3 [Deprecated]
Powered by GitBook
On this page
  • A criação de Tokens pode ser feita de duas maneiras:
  • Login
  • Gera um Token de Acesso para as credenciais fornecidas:
  • Pedidos com Autenticação
  1. Introdução

Autenticação

Para aceder à API, um token de acesso deverá ser usado. Um Token está associado a um Utilizador autenticado numa Localização, num Terminal e numa Caixa, na sua empresa. Tudo o que for feito usando um Token, terá a autoria atribuída ao utilizador associado e reger-se-á pelas suas permissões na aplicação.

A criação de Tokens pode ser feita de duas maneiras:

  • BackOffice: Poderá criar Tokens acedendo ao BackOffice, em Empresa Tokens de Acesso à API, onde poderá atribuir o Token a um Utilizador, Localização e Terminal.

  • Usando a própria API: Pode obter um Token fazendo um pedido ao end-point /auth/login, incluindo as suas credenciais de autenticação, obtendo na resposta o Token que poderá utilizar nos pedidos posteriores.

Login

Gera um Token de Acesso para as credenciais fornecidas:

POST https://api.cloudinvoice.net/auth/login/

Request Body

Name
Type
Description

username*

email

password*

string

company_code

string

till_code

string

{
    // Response
}
curl -X POST https://api.cloudinvoice.net/auth/login/
    -d '{
        "username": "user@sample.com",
        "password": "pFS2VwMk"
    }'
{
    "key": "329c2d5cadd96ccce7b0b0f2653e8d08f61ddd52"
}

Para além das credenciais username/password, pode também incluir a Empresa company_code e a Caixa till_code a que pretende associar o token de acesso.

Pedidos com Autenticação

Para efectuar pedidos com autenticação, deverá usar um dos seguintes métodos:

  • Incluir o Header HTTP: Authorization: Token <token>

curl https://api.cloudinvoice.net/customers/
    -H "Content-Type: application/json"
    -H "Authorization: Token 329c2d5cadd96ccce7b0b0f2653e8d08f61ddd52"
  • Incluir o Query Param: api_token=<token>

curl https://api.cloudinvoice.net/customers/?api_token=329c2d5cadd96ccce7b0b0f2653e8d08f61ddd52
    -H "Content-Type: application/json"

Em pedidos POST deve incluir sempre o

Header: Content-Type: application/json;

PreviousComeçar a UtilizarNextExemplos de Pedidos

Last updated 2 years ago