Epicor Kinetic REST API Services Overview.pptx

Epicor REST API Overview

1. Epicor REST API Introduction

2. Agenda for Today’s Discussion

3. Introduction to Epicor REST Services

4. Kinetic REST Overview

5. Introduction to Epicor REST Services Through REST API, services link applications more easily through internet-type connections. REST architecture considers both data and functions as web resources accessible through endpoints. These services use OData REST Protocol which adds query capabilities and metadata descriptions that enable OData-aware applications to display real-time Kinetic data. Applications can then communicate with Kinetic through REST services in the same way a web browser interacts with a website.

6. Configuring REST

7. Accessing the REST Root Directory. Common URL Format: https://[KineticServer]/[KineticInstance]/apps/resthelp/ Understanding API Versions. Creating and Configuring the API Key for v2. Prerequisites:

8. Using REST API Interactive Help Page.

9. Home Page Browse Menu Favorites User Menu Kinetic Help Page

10. Search Box. Service List. Business Activity Queries. Epicor Functions. The Browse Menu

11. User Menu

12. Calling Kinetic Services

13. The Kinetic REST Services interact with your Kinetic database. Each Kinetic service contains these main parts: OData Datasources - REST uses these datasources to display and modify the data in a format consumable by web applications. Methods - Use both standard and custom methods to access, add, and update data within the main tableset for each service.

14. Invoking Epicor Functions

15. Functions are an evolution of the existing BPM data and method directives. Function tools can make Kinetic Services into custom reusable logic you can apply to Kinetic - externally (using REST) or internally (from a BPM directive or another Function, or as a scheduled task). Functions are grouped by library. A library can be published or unpublished (for example, when being developed or updated).

16. Working with Kinetic REST API

17. Troubleshooting and Security

18. Understanding REST API Exceptions HTTP Error Code Name Description 403 - Forbidden UnauthorizedAccessException Access to method is disabled 400 - Bad request Microsoft.Data.OData . ODataException OData cannot process received query 403 - Forbidden Ice.Common.RecordNotFoundException Requested item is not found 409 - Conflict DuplicateRecordException There is a duplicate record shown on the client 400 - Bad request Ice.Common.BusinessObjectException There is an error in business logic. 500 - Internal server error All Other Exceptions These errors do not display on the client

19. Using Access Scope for additional security

20. Thank You !