E-CUBE Web API Help Page

Introduction

E-CUBE Web Api service is a RESTful service to provide integration between heterogeneous software.

It allows ERP management systems and third-party applications such as E-Commerce, CRP solutions, Android or iOS mobile applications to communicate with each other, completely based on HTTP calls and data exchange in JSON format

Resource

Use this module for CRUD oprations on resources.

API	Description
POST api/resources/ECCOEtlConfigExt	No documentation available.
GET api/resources/ECCOEtlConfigExt?templateId={templateId}	No documentation available.
GET api/resources/{Resource}/new	No documentation available.
GET api/resources/{Resource}?Viewname={Viewname}&RecordSelection={RecordSelection}&PageSize={PageSize}&PageNumber={PageNumber}&StatsOnly={StatsOnly}&NoCounter={NoCounter}	No documentation available.
POST api/resources/{Resource}	Insert/Update resource matching by key info
POST api/resources/{Resource}/query?PageSize={PageSize}&PageNumber={PageNumber}&RecordSelection={RecordSelection}	Query resource with specific filters. Filters must be specified in HTTP request body filling ResourceViewesFilters structure
POST api/resources/{Resource}/validate	Validate resource befor POST it
PATCH api/resources/{Resource}	No documentation available.
DELETE api/resources/{Resource}/{id}	Delete resource by Id
DELETE api/resources/{Resource}	Delete resource using its data and key informations

Account

API	Description
GET api/Account/GetUsers	No documentation available.
POST api/Account/ManageUser?command={command}	No documentation available.
GET api/Account/TokenInfo	Get associated token info
GET api/Account/GetExternalInfo?ExternalId={ExternalId}	No documentation available.
POST api/Account/IsTokenValid	Method to test token's valodity associated to the current request
POST api/Account/Logout	Leave and logout current token
POST api/Account/ForgotPassword	No documentation available.
POST api/Account/CheckResetPasswordToken	No documentation available.
POST api/Account/TokenResetPassword	No documentation available.
POST api/Account/Impersonate	No documentation available.
POST api/Account/Login	No documentation available.

Report

API	Description
GET api/report/{Resource}	No documentation available.
POST api/Report	No documentation available.
PUT api/Report/{id}	No documentation available.
DELETE api/Report/{id}	No documentation available.

Sync

Use this api module, for bulk syncronization operation with your software.

API	Description
GET api/sync/{Resource}?LastUtcRun={LastUtcRun}&Viewname={Viewname}&RecordSelection={RecordSelection}&PageNumber={PageNumber}&PageSize={PageSize}&NoCounter={NoCounter}&StatsOnly={StatsOnly}&Bulk={Bulk}	No documentation available.
POST api/sync/{Resource}?recoursive={recoursive}	No documentation available.
POST api/sync/{Resource}/validate	No documentation available.
PATCH api/sync/{Resource}	No documentation available.

DataExchange

API	Description
POST api/dataexchange/Columns	No documentation available.
POST api/dataexchange/Preview?filter={filter}	No documentation available.
POST api/dataexchange/Job	No documentation available.
GET api/dataexchange/Job?job_id={job_id}	No documentation available.
POST api/DataExchange?job_id={job_id}&filter={filter}	No documentation available.