Introdução
API Endpoint
https://apialpha.alphasystemas.com.br/
Todas as APIs da Alpha Systemas foram desenvolvidas baseadas na tecnologia REST, seguindo os atuais
padrões técnicos de mercado.
Tudo isso para que a experiência na hora da integração seja a mais fácil possível.
Todas as URLs são amigáveis e orientadas a recursos e utilizam os padrões do protocolo HTTP como
autenticação, verbos e códigos de retorno.
Isso permite que APIs possam ser utilizadas por clientes HTTP já existentes.
Todas as respostas são retornadas no formato JSON.
Como pode ser visto abaixo, as APIs foram cuidadosamente trabalhadas para que os termos de negócios
contidos sejam facilmente entendidos por desenvolvedores que não tenham conhecimento prévio do sistema.
Elas foram meticulosamente estudadas para que um nome de campo em um endpoint tenha rigorosamente o
mesmo significado em outros recursos
Atenção: Todos os testes devem ser realizados em produção, porém, ao fazer um faturamento de
pedido des testes será necessário excluir o pedido no sistema AlphaInd.
Toda a comunicação (recebimento e envio de dados) utiliza tokens para autenticação.
Veja na tabela abaixo quais são os tokens e os fluxos:
| Header |
Fluxo |
| token-alphaind |
E-Commerce > AlphaInd |
| token-alphaind |
AlphaInd > E-Commerce |
*O token será fornecido pelo administrador do sistema AlphaInd.
Gerando Token
No sistema alphaind, módulo comercial, menu cadastro, opção Empresas/Lojas, na aba Configuração,
clicar no botão para gerar o token que será copiado para área de transferencia.
Obter Produtos
# Here is a curl example
curl
-X GET apialpha.alphasystemas.com.br/produtos
-H 'Content-Type=application/json'
-H 'token-alphaind=seu_token'
Para obter produtos, você precisa fazer uma chamada GET para o seguinte url:
https://apialpha.alphasystemas.com.br/produtos
Result example :
{
"Dados": [
{
"Referencia": "0100002",
"Titulo": "CAMISA M/L CLÁSSICA UNIC EM ALGODÃO EGIPCIO",
"DescricaoDetalhada": "",
"Peso": 0.3,
"Preco": 199.9000,
"UrlAmigavel": "CAMISA-ML-CLÁSSICA-UNIC-EM-ALGODÃO-EGIPCIO",
"Grupo": {
"Id": 1,
"Descricao": "CAMISA M/L"
},
"Colecao": {
"Id": 221,
"Descricao": "COLEÇÃO JUNHO 2020"
},
"Linha": {
"Id": 1,
"Descricao": "PRINCIPAL"
},
"Genero": 1,
"Estoque": 16,
"ProdutoSku": [
{
"Sku": "0100002-0835-5",
"Referencia": "0100002",
"Posicao": 5,
"CodigoCor": 835,
"Tamanho": "G",
"Cor": "FERRUGEM",
"Estoque": 8
},
{
"Sku": "0100002-0004-6",
"Referencia": "0100002",
"CodigoTamanho": 6,
"CodigoCor": 4,
"Tamanho": "GG",
"Cor": "AZUL ROYAL",
"Estoque": 8
}
]
}
],
"Pagina": 1,
"ItensPorPagina": 20,
"QtdedePaginas": 1
}
HEADER PARAMETERS
| Campo |
Tipo |
Descrição |
| Content-Type |
String |
application/json |
| token-alphaind |
String |
Exemplo: "5b008cef7f321d00ef2367b2" |
QUERY PARAMETERS
| Campo |
Tipo |
Descrição |
| referencia |
string |
(opcional - default: 0) código do produto |
| grupo |
int |
(opcional - default: 0) grupo do produto |
| colecao |
int |
(opcional - default: 0) colecao do produto |
| linha |
int |
(opcional - default: 0) linha do produto |
| pagina |
int |
(opcional - default: 1) Um cursor para uso na paginação. A paginação começa com o
deslocamento especificado |
| itensPorPagina |
int |
(opcional - default: 20) Um limite para o número de objetos a serem retornados, entre 1 e
100. |
| atacado |
int |
(opcional - default: 0) Identifica se é para verificar no atacado ou no varejo. |
| estoque |
bool |
(opcional - default: false) Identifica se deve retornar apenas produtos em estoque. |
Obter Produtos Atualizados
# Here is a curl example
curl
-X GET apialpha.alphasystemas.com.br/produtos/atualizados
-H 'Content-Type=application/json'
-H 'token-alphaind=seu_token'
Para obter os produtos que foram atualizado, você precisa fazer uma chamada GET para o seguinte url:
https://apialpha.alphasystemas.com.br/produtos/atualizados
Result example :
{
"Dados": [
{
"Referencia": "0100002",
"Titulo": "CAMISA M/L CLÁSSICA UNIC EM ALGODÃO EGIPCIO",
"DescricaoDetalhada": "",
"Peso": 0.3,
"Preco": 199.9000,
"UrlAmigavel": "CAMISA-ML-CLÁSSICA-UNIC-EM-ALGODÃO-EGIPCIO",
"Grupo": {
"Id": 1,
"Descricao": "CAMISA M/L"
},
"Colecao": {
"Id": 221,
"Descricao": "COLEÇÃO JUNHO 2020"
},
"Linha": {
"Id": 1,
"Descricao": "PRINCIPAL"
},
"Genero": 1,
"Estoque": 16,
"ProdutoSku": [
{
"Sku": "0100002-0835-5",
"Referencia": "0100002",
"Posicao": 5,
"CodigoCor": 835,
"Tamanho": "G",
"Cor": "FERRUGEM",
"Estoque": 8
},
{
"Sku": "0100002-0004-6",
"Referencia": "0100002",
"CodigoTamanho": 6,
"CodigoCor": 4,
"Tamanho": "GG",
"Cor": "AZUL ROYAL",
"Estoque": 8
}
]
}
],
"Pagina": 1,
"ItensPorPagina": 20,
"QtdedePaginas": 1
}
HEADER PARAMETERS
| Campo |
Tipo |
Descrição |
| Content-Type |
String |
application/json |
| token-alphaind |
String |
Exemplo: "5b008cef7f321d00ef2367b2" |
QUERY PARAMETERS
| Campo |
Tipo |
Descrição |
| referencia |
string |
(opcional - default: 0) código do produto |
| grupo |
int |
(opcional - default: 0) grupo do produto |
| colecao |
int |
(opcional - default: 0) colecao do produto |
| linha |
int |
(opcional - default: 0) linha do produto |
| pagina |
int |
(opcional - default: 1) Um cursor para uso na paginação. A paginação começa com o
deslocamento especificado |
| itensPorPagina |
int |
(opcional - default: 20) Um limite para o número de objetos a serem retornados, entre 1 e
100. |
| atacado |
int |
(opcional - default: 0) Identifica se é para verificar no atacado ou no varejo. |
| estoque |
bool |
(opcional - default: false) Identifica se deve retornar apenas produtos em estoque. |
Obter EstoqueSKU
# Here is a curl example
curl
-X GET apialpha.alphasystemas.com.br/produtos/obterestoquesku
-H 'Content-Type=application/json'
-H 'token-alphaind=seu_token'
Para obter os estoques dos skus dos produtos, você precisa fazer uma chamada GET para o seguinte
url:
https://apialpha.alphasystemas.com.br/produtos/obterestoquesku
Result example :
{
"Dados": [
{
"Sku": "0000000-0001-1",
"Estoque": 2
},
{
"Sku": "0000000-0001-2",
"Estoque": 50
},
{
"Sku": "0000000-0001-3",
"Estoque": 12
},
{
"Sku": "0000000-0001-4",
"Estoque": 4
},
{
"Sku": "0000000-0001-5",
"Estoque": 3
},
{
"Sku": "0000000-0001-6",
"Estoque": 98
},
{
"Sku": "0000000-0001-7",
"Estoque": 5
},
{
"Sku": "0000000-0001-8",
"Estoque": 0
},
{
"Sku": "0000000-0003-1",
"Estoque": 0
},
{
"Sku": "0000000-0003-2",
"Estoque": 40
},
{
"Sku": "0000000-0003-3",
"Estoque": 0
},
{
"Sku": "0000000-0003-4",
"Estoque": 36
},
{
"Sku": "0000000-0003-5",
"Estoque": 12
},
{
"Sku": "0000000-0003-6",
"Estoque": 1
},
{
"Sku": "0000000-0003-7",
"Estoque": 33
},
{
"Sku": "0000000-0003-8",
"Estoque": 1
},
{
"Sku": "0000000-0004-1",
"Estoque": 8
},
{
"Sku": "0000000-0004-2",
"Estoque": 3
},
{
"Sku": "0000000-0004-3",
"Estoque": 1
},
{
"Sku": "0000000-0004-4",
"Estoque": 0
}
],
"Pagina": 1,
"ItensPorPagina": 20,
"QtdedePaginas": 5623
}
HEADER PARAMETERS
| Campo |
Tipo |
Descrição |
| Content-Type |
String |
application/json |
| token-alphaind |
String |
Exemplo: "5b008cef7f321d00ef2367b2" |
QUERY PARAMETERS
| Campo |
Tipo |
Descrição |
| referencia |
string |
(opcional - default: "") código do produto |
| sku |
string |
(opcional - default: "") sku do produto |
| pagina |
int |
(opcional - default: 1) Um cursor para uso na paginação. A paginação começa com o
deslocamento especificado |
| itensPorPagina |
int |
(opcional - default: 20) Um limite para o número de objetos a serem retornados, entre 1 e
100. |
Obter Grupos
# Here is a curl example
curl
-X GET apialpha.alphasystemas.com.br/produtos/grupos
-H 'Content-Type=application/json'
-H 'token-alphaind=seu_token'
Para obter grupos, você precisa fazer uma chamada GET para o seguinte url:
https://apialpha.alphasystemas.com.br/produtos/grupos
Result example :
{
"Dados": [
{
"Id": 52,
"Descricao": "ACESSÓRIOS"
},
{
"Id": 47,
"Descricao": "ALMOXARIFADO"
},
{
"Id": 37,
"Descricao": "BERMUDAS"
},
{
"Id": 32,
"Descricao": "BLAZER"
},
{
"Id": 2,
"Descricao": "BLUSAS"
}
],
"Pagina": 1,
"ItensPorPagina": 5,
"QtdedePaginas": 15
}
HEADER PARAMETERS
| Campo |
Tipo |
Descrição |
| Content-Type |
String |
application/json |
| token-alphaind |
String |
Exemplo: "5b008cef7f321d00ef2367b2" |
QUERY PARAMETERS
| Campo |
Tipo |
Descrição |
| descricao |
string |
(opcional - default: "") descrição do grupo |
| pagina |
int |
(opcional - default: 1) Um cursor para uso na paginação. A paginação começa com o
deslocamento especificado |
| itensPorPagina |
int |
(opcional - default: 20) Um limite para o número de objetos a serem retornados, entre 1 e
100. |
Obter Linhas
# Here is a curl example
curl
-X GET apialpha.alphasystemas.com.br/produtos/linhas
-H 'Content-Type=application/json'
-H 'token-alphaind=seu_token'
Para obter linhas, você precisa fazer uma chamada GET para o seguinte url:
https://apialpha.alphasystemas.com.br/produtos/linhas
Result example :
{
"Dados": [
{
"Id": 1,
"Descricao": "ALPHA"
},
{
"Id": 1,
"Descricao": "DAREJO"
},
{
"Id": 3,
"Descricao": "OMEGA"
}
],
"Pagina": 1,
"ItensPorPagina": 5,
"QtdedePaginas": 1
}
HEADER PARAMETERS
| Campo |
Tipo |
Descrição |
| Content-Type |
String |
application/json |
| token-alphaind |
String |
Exemplo: "5b008cef7f321d00ef2367b2" |
QUERY PARAMETERS
| Campo |
Tipo |
Descrição |
| descricao |
string |
(opcional - default: "") descrição da linha |
| pagina |
int |
(opcional - default: 1) Um cursor para uso na paginação. A paginação começa com o
deslocamento especificado |
| itensPorPagina |
int |
(opcional - default: 20) Um limite para o número de objetos a serem retornados, entre 1 e
100. |
Obter Colecoes
# Here is a curl example
curl
-X GET apialpha.alphasystemas.com.br/produtos/colecoes
-H 'Content-Type=application/json'
-H 'token-alphaind=seu_token'
Para obter colecoes, você precisa fazer uma chamada GET para o seguinte url:
https://apialpha.alphasystemas.com.br/produtos/colecoes
Result example :
{
"Dados": [
{
"Id": 1,
"Descricao": "ALTO VERAO"
},
{
"Id": 2,
"Descricao": "ALTO INVERNO"
},
{
"Id": 3,
"Descricao": "BAZAR"
},
{
"Id": 4,
"Descricao": "BLUZA"
},
{
"Id": 5,
"Descricao": "BRINDES"
}
],
"Pagina": 1,
"ItensPorPagina": 5,
"QtdedePaginas": 15
}
HEADER PARAMETERS
| Campo |
Tipo |
Descrição |
| Content-Type |
String |
application/json |
| token-alphaind |
String |
Exemplo: "5b008cef7f321d00ef2367b2" |
QUERY PARAMETERS
| Campo |
Tipo |
Descrição |
| descricao |
string |
(opcional - default: "") descrição da coleção |
| pagina |
int |
(opcional - default: 1) Um cursor para uso na paginação. A paginação começa com o
deslocamento especificado |
| itensPorPagina |
int |
(opcional - default: 20) Um limite para o número de objetos a serem retornados, entre 1 e
100. |
Obter Categorias
# Here is a curl example
curl
-X GET apialpha.alphasystemas.com.br/produtos/categorias
-H 'Content-Type=application/json'
-H 'token-alphaind=seu_token'
Para obter categorias, você precisa fazer uma chamada GET para o seguinte url:
https://apialpha.alphasystemas.com.br/produtos/categorias
Result example :
{
"Dados": [
{
"Id": 2,
"Descricao": "FASHION"
},
{
"Id": 1,
"Descricao": "JEANS"
}
],
"Pagina": 1,
"ItensPorPagina": 20,
"QtdedePaginas": 1
}
HEADER PARAMETERS
| Campo |
Tipo |
Descrição |
| Content-Type |
String |
application/json |
| token-alphaind |
String |
Exemplo: "5b008cef7f321d00ef2367b2" |
QUERY PARAMETERS
| Campo |
Tipo |
Descrição |
| descricao |
string |
(opcional - default: "") descrição da categoria |
| pagina |
int |
(opcional - default: 1) Um cursor para uso na paginação. A paginação começa com o
deslocamento especificado |
| itensPorPagina |
int |
(opcional - default: 20) Um limite para o número de objetos a serem retornados, entre 1 e
100. |
Obter Vendas
# Here is a curl example
curl
-X GET apialpha.alphasystemas.com.br/vendas/
-H 'Content-Type=application/json'
-H 'token-alphaind=seu_token'
Para obter as vendas, você precisa fazer uma chamada GET para o seguinte url:
https://apialpha.alphasystemas.com.br/vendas
Result example :
{
"Dados": [
{
"Codigo": 100001,
"Data": "19/05/2021",
"ValorVenda": "23.97",
"ValorDevolucao": "80.00",
"ValorDevolucaoTroca": "50.00",
"ValorEntrega": "5.00"
},
{
"Codigo": 100002,
"Data": "20/05/2021",
"ValorVenda": "160.00",
"ValorDevolucao": "80.00",
"ValorDevolucaoTroca": "80.00",
"ValorEntrega": "0.00"
},
{
"Codigo": 100003,
"Data": "27/05/2021",
"ValorVenda": "800.00",
"ValorDevolucao": "30.00",
"ValorDevolucaoTroca": "30.00",
"ValorEntrega": "5.00"
}
],
"Pagina": 1,
"ItensPorPagina": 20,
"QtdedePaginas": 1
}
HEADER PARAMETERS
| Campo |
Tipo |
Descrição |
| Content-Type |
String |
application/json |
| token-alphaind |
String |
Exemplo: "5b008cef7f321d00ef2367b2" |
QUERY PARAMETERS
| Campo |
Tipo |
Descrição |
| dataInicio |
Date |
(opcional - default: null) Data inicial para filtrar as vendas. A data deve seguir o formato
yyyy/mm/dd, yyyy-mm-dd ou yyyy.mm.dd. |
| dataFim |
Date |
(opcional - default: null) Data final para filtrar as vendas. A data deve seguir o formato
yyyy/mm/dd, yyyy-mm-dd ou yyyy.mm.dd. |
| codigo |
int |
(opcional - default: 0) Código da venda. |
| pagina |
int |
(opcional - default: 1) Um cursor para uso na paginação. A paginação começa com o
deslocamento especificado |
| itensPorPagina |
int |
(opcional - default: 20) Um limite para o número de objetos a serem retornados, entre 1 e
100. |
Resetar Produtos Atualizados
# Here is a curl example
curl
-X POST apialpha.alphasystemas.com.br/produtos/resetaratualizados
-H 'Content-Type=application/json'
-H 'token-alphaind=seu_token'
Para resetar um produto atualizado, você precisa fazer uma chamada PUT para o seguinte url:
https://apialpha.alphasystemas.com.br/produtos/resetaratualizados
HEADER PARAMETERS
| Campo |
Tipo |
Descrição |
| Content-Type |
String |
application/json |
| token-alphaind |
String |
Exemplo: "5b008cef7f321d00ef2367b2" |
Faturar Pedido
# Here is a curl example
curl
-X POST apialpha.alphasystemas.com.br/pedidos/faturar
-H 'Content-Type=application/json'
-H 'token-alphaind=seu_token'
Para faturar um pedido, você precisa fazer uma chamada POST para o seguinte url:
https://apialpha.alphasystemas.com.br/pedidos/faturar
Body example :
{
"Id": "48AAC843",
"Cliente": {
"Nome": "GABRIEL TESTE",
"CPF": "123456789100",
"Telefone": "8533119292",
"Celular": "85998421728",
"Email": "desenvolvimento@alphasystemas.com.br",
"Enderecos": [
{
"Id": 0,
"Cep": "60000000",
"Rua": "RUA FANTASMA",
"Numero": 0,
"Complemento": "CASA FANTASMA",
"Bairro": "FANTASMA",
"Cidade": "FORTALEZA",
"CodigoIbge": "2304400",
"UF": "CE",
"Tipo": 1
}
]
},
"FormaPagamento": "BOLETO",
"Frete": 12,
"Itens": [
{
"Referencia": "0205041",
"CodigoCor": 72,
"CodigoTamanho": 1,
"Unitario": 60,
"Qtde": 1
},
{
"Referencia": "0205041",
"CodigoCor": 72,
"CodigoTamanho": 2,
"Unitario": 60,
"Qtde": 1
}
]
}
HEADER PARAMETERS
| Campo |
Tipo |
Descrição |
| Content-Type |
String |
application/json |
| token-alphaind |
String |
Exemplo: "5b008cef7f321d00ef2367b2" |
Algumas das opções possiveis para a forma de pagamento a ser passada no corpo da requisição são:
FORMAS DE PAGAMENTO
| Formas |
Tipo |
| DINHEIRO |
String |
| BOLETO |
String |
| DEPOSITO_EM_CONTA |
String |
| PAGSEGURO |
String |
Erros
A API usa os seguintes códigos de erro:
| Error Code |
Meaning |
| 500 |
Erro interno do servidor
|
| 400 |
url não encontrada
|
| 200 |
erro de validação, no caso do 200 também se referere a uma requisição success!!!
|
