Portal do Desenvolvedor

Documentação

Este é o portal do desenvolvedor Sysfood Delivery.
Aqui se encontram as informações necessárias para integração com a nossa API.

Geral

  • Os dados de acesso para o desenvolvimento (token_id, empresa_id) são fornecidos pela Syspan Informática.
  • Os dados definitivos, de produção, serão fornecidas após a homologação da integração.
  • Toda as requisições realizadas devem ser feitas sob protocolo HTTPS.
  • Para cada requisição é exigido um token identificador.

Eventos

  • Abrir e fechar a loja (Online/Offline).
  • Receber os pedidos.
  • Aceitar ou Cancelar cada pedido.
  • Alterar a situação de cada pedido como pronto para retirada ou entrega.

Endereço API

https://apihomologacao.sysfooddelivery.com.br

Para modo de produção um outro endereço será fornecido.


Loja

Parâmetros

                                { 
                                    "token_id": string,
                                    "empresa_id": number
                                }
                                

Respostas

HTTP Status Code Descrição
200
                                           {
                                                "nome": string,
                                                "online": number, //0 -> offline, 1 -> online
                                                "endereco": string,
                                                "bairro": string,
                                                "tempo_entrega_minimo": number,
                                                "tempo_entrega_maximo": number
                                            }
                                        
400
                                            {
                                                "message": "token vazio ou invalido"
                                            }
                                        
404
                                            {
                                                "message": "O caminho ou metodo solicitado não foi encontrado"
                                            }
                                        

Parâmetros

                                { 
                                    "token_id": string,
                                    "empresa_id": number
                                }
                                

Respostas

HTTP Status Code Descrição
200
                                           {
                                                "nome": string,
                                                "online": number, //0 : offline, 1 : online
                                                "endereco": string,
                                                "bairro": string
                                            }
                                        
400
                                            {
                                                "online": 1, 
                                            }
                                        
404
                                            {
                                                "message": "O caminho ou metodo solicitado não foi encontrado"
                                            }
                                        

Parâmetros

                                { 
                                    "token_id": string,
                                    "empresa_id": number
                                }
                                

Respostas

HTTP Status Code Descrição
200
                                            {               
                                                "online": 0, 
                                            }
                                        
400
                                            {
                                                "message": "token vazio ou invalido"
                                            }
                                        
404
                                            {
                                                "message": "O caminho ou metodo solicitado não foi encontrado"
                                            }
                                        

Parâmetros

                                { 
                                    "token_id": string,
                                    "empresa_id": number,
                                    "tempo_minimo": number,
                                    "tempo_maximo": number
                                }
                                

Respostas

HTTP Status Code Descrição
200
                                            {               
                                                "tempo_minimo": tempo mínimo de entrega (number),
                                                "tempo_maximo": tempo máximo de entrega (number), 
                                            }
                                        
452
                                            {
                                                "message": "Os tempos de entrega não podem ser iguais a zero."
                                            }
                                        
453
                                            {
                                                "message": "Os tempos de entrega não pode ser iguais."
                                            }
                                        
454
                                            {
                                                "message": "O tempo mínimo tem que ser menor que o tempo máximo de entrega."
                                            }
                                        
404
                                            {
                                                "message": "O caminho ou metodo solicitado não foi encontrado"
                                            }
                                        


Pedidos

São exibidos os pedidos feitos nas últimas 24 horas.

Os pedidos são listados em ordem descrescente de criação.

É possível filtrar os pedidos passando parâmetros pela query string.
Ex.: /pedidos?min_id_pedido=10500&status_pedido=1

Filtros
  • min_id_pedido: integer - Mínimo id do pedido
  • status_pedido: integer - Status do pedido (0: Recebido, 1: Produção, 2: Pronto/Entrega, 3: Cancelado, 4: Entregue)
Parâmetros

                                { 
                                    "token_id": string,
                                    "empresa_id": number
                                }
                                

Respostas

HTTP Status Code Descrição
200
                                           {
    "dados": [
        {
            "id_pedido": integer,
            "codigo": string,
            "cpf": string,
            "nome_cliente": string,
            "telefone": string,
            "horario_pedido": "21/01 - 06:16",
            "horario_recebido": "",
            "horario_entrega": "",
            "status_pedido": "1", // 0: Recebido, 1: Produção, 2: Pronto/Entrega, 3: Cancelado, 4: Entregue
            "total": "28.00",
            "valor_entrega": "2.00",
            "valor_desconto": "",
            "total_geral": "15.00",
            "cupom": "",
            "meio_pagamento": "CARTAO", //DINHEIRO, CARTAO, ONLINE 
            "meio_pagamento_submeio": "Visa", // Bandeira do cartão ou vazio se meio_pagamento for DINHEIRO
            "tipo_entrega": "1", // 0: buscar, 1: Entrega
            "cpf_cnpj": "string" //CPF/CNPJ na nota fiscal
            "app_lojista": "0", // 0: Sysfood, 1: Aplicativo próprio (lojista)
        }
    ]
}
                                        
400
                                            {
                                                "message": "token vazio ou invalido"
                                            }
                                        
404
                                            {
                                                "message": "O caminho ou metodo solicitado não foi encontrado"
                                            }
                                        

Parâmetros

                                { 
                                    "token_id": string,
                                    "empresa_id": number
                                }
                                

Respostas

HTTP Status Code Descrição
200
                                            {               
                                                "resp": ok, 
                                            }
                                        
400
                                            {
                                                "message": "token vazio ou invalido"
                                            }
                                        
404
                                            {
                                                "message": "O caminho ou metodo solicitado não foi encontrado"
                                            }
                                        

Parâmetros

                                { 
                                    "token_id": string,
                                    "empresa_id": number
                                }
                                

Respostas

HTTP Status Code Descrição
200
                                            {               
                                                "resp": ok, 
                                            }
                                        
400
                                            {
                                                "message": "token vazio ou invalido"
                                            }
                                        
404
                                            {
                                                "message": "O caminho ou metodo solicitado não foi encontrado"
                                            }
                                        

Parâmetros

                                { 
                                    "token_id": string,
                                    "empresa_id": number
                                }
                                

Respostas

HTTP Status Code Descrição
200
                                            {               
                                                "resp": ok, 
                                            }
                                        
400
                                            {
                                                "message": "token vazio ou invalido"
                                            }
                                        
404
                                            {
                                                "message": "O caminho ou metodo solicitado não foi encontrado"
                                            }
                                        

Parâmetros

                                { 
                                    "token_id": string,
                                    "empresa_id": number
                                }
                                

Respostas

HTTP Status Code Descrição
200
                                            {               
                                                "online": 0, 
                                            }
                                        
400
                                            {
                                                "message": "token vazio ou invalido"
                                            }
                                        
404
                                            {
                                                "message": "O caminho ou metodo solicitado não foi encontrado"
                                            }
                                        

Parâmetros

                                { 
                                    "token_id": string,
                                    "empresa_id": number
                                }
                                

Respostas

HTTP Status Code Descrição
200
                                            {               
                                                "resp": ok, 
                                            }
                                        
400
                                            {
                                                "message": "token vazio ou invalido"
                                            }
                                        
404
                                            {
                                                "message": "O caminho ou metodo solicitado não foi encontrado"
                                            }
                                        

Parâmetros

                                { 
                                    "token_id": string,
                                    "empresa_id": number
                                }
                                

Respostas

HTTP Status Code Descrição
200
                                             {
    "resp": "ok",
    "produtos": [
        {
            "id": "21281",
            "nome_produto": "Coca-Cola Lata",
            "valor_unitario": "3.00",
            "qtd": "5",
            "qtd_sabores": "0",
            "meia": "0",
            "tamanho": "",
            "observacao": "",
            "id_produto_meia": "0",
            "cod_barras": "",
            "Produtos_Adicionais": [],
            "Produtos_Variacoes": []
        },
        {
            "id": "21282",
            "nome_produto": "Guarana",
            "valor_unitario": "3.50",
            "qtd": "5",
            "qtd_sabores": "0",
            "meia": "0",
            "tamanho": "",
            "observacao": "",
            "id_produto_meia": "0",
            "cod_barras": "",
            "Produtos_Adicionais": [],
            "Produtos_Variacoes": []
        }
    ],
    "pagamento": {
        "cod_pagamento": "1",
        "descricao": "Dinheiro",
        "meio_pagamento_submeio": "",
        "frete": "2.00",
        "total": "34.50",
        "troco": "0.00",
        "cupom": "",
        "cupom_geral": "",
        "valor_desconto": "0.00"
    },
    "endereco": {
        "nome_cliente": "Miguel Souza",
        "cpf": "12345678998",
        "telefone": "(14) 99771-0387",
        "cep": "17600-010",
        "estado": "SP",
        "cidade": "Tupã",
        "endereco": "Rua Coroados",
        "numero": "869",
        "bairro": "Centro",
        "complemento": "",
        "referencia": "Próx Hospital São Francisco"
    },
    "cod_pedido": "#E6A2101211208",
    "empresa": "10000",
    "telefone_empresa": "0143496203",
    "horario_pedido": "2021-01-25 07:12:08",
    "tipo_entrega": "1",
    "cpf_cnpj": "123.456.789-98",
    "avaliacao": "0",
    "app_lojista": "0", // 0: Sysfood, 1: Aplicativo próprio (lojista)
}
                                        
400
                                            {
                                                "message": "token vazio ou invalido"
                                            }
                                        
404
                                            {
                                                "message": "O caminho ou metodo solicitado não foi encontrado"
                                            }
                                        

Contato