Ir para o conteúdo

Ecommerce

Documento de Integração FoccoERP - E-commerce - Relação de Webservices

1. Introdução

Esse documento identifica os webservices que são utilizados para a integração entre as aplicações de e-commerce e Focco. Estão definidos aqui os endereços dos webservices, bem como seus parâmetros de entrada e saída.

No endereço dos webservices abaixo descritos, há o trecho “<endereçoERP>” nos mesmos que deve ser alterado conforme o cliente em questão. Esse endereço será o link de acesso à aplicação web da Focco. Todos as requisições aos webservices devem ter, em seu cabeçalho a chave “Content-Type” como “application/json”.

Segue, abaixo, a relação de webservices.

2. Requisitar Acesso

Endereço:

URL: <endereçoERP>/api/authentication/requestaccess

Esse webservice irá realizar a requisição de autenticação com o sistema.

Entrada:

Parâmetros Descrição
ClientID Deve ser passado fixo como “ECOMMERCE”, que define o tipo de autenticação para essa aplicação em específico.
User Deve ser um usuário de conexão ao FoccoERP, cadastrado pelo próprio cliente para o e-commerce.
Password Deve ser a senha de conexão do usuário ao FoccoERP, cadastrado pelo próprio cliente para o e-commerce.
KillOthersSessions Define se irá encerrar as sessões abertas do usuário informado ao realizar a autenticação. Como a aplicação de eCommerce permite várias conexões simultâneas, deve ser passado como “false”.

Exemplo:

{
    ClientID: "ECOMMERCE",
    User: "<usuário>",
    Password: "<senha>",
    KillOtherSessions: false
}

Saída:

O json de retorno da requisição de autenticação irá retornar um token que deverá ser utilizado no cabeçalho das outras chamadas de webservices, na chave “Authorization”, com a seguinte informação: “Bearer <token>

Exemplo:

{
    "$id": "32282",
    "ErrorReason": 0,
    "CustomErrorMessage": null,
    "Token": "CfDJ8N9H4sMCRcZJj7vaStaDeKjUduS6BEpAXl6KimLfnZWDfD2GunFWISyFgqQasaSD77Q9jcqhAM3tOhSwiRj0vTr8UEhKjo1_E6DPa1nBqrD6AggY6fpdaTXIhRhFYp1ETjwst86Vddu3f3tqXSn0RlbwzlPHu2HHa0DbxSBShPvLXVCWokJCQOgl_op66idLBgUbrjQq0cSCZox79g2PxyydUF0Uj4JdpgTq36WLwxeAdUTansW4q_G8XuTpaSxCjKTLXJFdSwso3hw_yOb8osHHnI0-yyvOIDaeM1-PRvvv_2iPAClUp8Eg4WV7JrPkKIcWGoaojpC1gE9qDoA043fYt_TRtDuZJ8-z38XgGuY7K4OLjb-_kgoYvONped6jtelsF7dW3I-XwZpR9Ds_QvnHUOoCc4JE-MmG8n1PPlGzJklcsJU5xwqXb1lcQOAbzMxjp-lkP-vZxsRouQvt9emSTCaaq1zIaZHCe6P_CLRH0kGDKX5I4FIuXIiUchNqSnzyVJ7NRCgkQiFrEGg9rpH2c00if6pfRsU2exAVAwCdrE9zK_QioTokOuLN8ON4bINVxCRsGH177yHaV_uOJJ-TYykZTCR8ssZpl0uIHGZZaxPnXA4GZZ_Ymj2F3AGgWBQBeFq-lJvL17H_p29kP-Tzw84Y4l8-3Jepu0mSrXul4t8cnOInol3VWQhk4c0bzurbgRpljYQuB5Sn0VinMLKbv602t6v59VPlu0OBpcAD",
    "IsSuccessful": true
}

3. Buscar Condições de Pagamento:

Endereço:

URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.GetCondicoesPagamentoCommand

Esse webservice irá buscar todas as condições de pagamento do sistema que estão marcadas para envio ao eCommerce.

Parâmetros
Esse webservice não requer parâmetros de entrada.

Saída:

Dados Descrição
ID ID interno da condição de pagamento no ERP.
Codigo Código da condição de pagamento que foi cadastrada no ERP.
Descricao Descrição da condição de pagamento que foi cadastrada no ERP.

Exemplo:

{
    "$id": "2",
    "$values": [
        {
            "$id": "3",
            "ID": 595,
            "Codigo": 3,
            "Descricao": "PARCELAMENTO LIVRE"
        },
        {
            "$id": "4",
            "ID": 727,
            "Codigo": 99,
            "Descricao": "TESTE FGK"
        }
    ]
}

4. Buscar Itens:

Endereço:

URL: /api/Commands/Comercial.Ecommerce.WebServices.GetItensCommand

Esse webservice busca todos os itens do sistema que estão marcados para envio ao eCommerce, retornando-os conforme a quantidade solicitada na requisição.

Parâmetros Descrição
skip Identifica a quantidade de registros que serão ignorados na busca dos itens. Os registros sempre retornarão ordenados, portanto ao informar esse parâmetro maior que zero, indica-se que a quantidade informada de registros não precisa ou não deve ser retornada.
take Identifica a quantidade de registros que devem ser retornados na