Delivery of ERP API sample calls + documentation

[AlexQua]

Tasks for the ERP Teams

Requirements

• Connection strings for development, test, and production environment
• API minimum functions (see the below-mentioned functions)
  • The ERP developer can start by reading this page. Please forward it to the responsible ERP developer!
• API sample application for showing how to use the API minimum functions (read the section below for more details)
  • ERP Developer hands over the API sample application in a Meeting to coolorange
• API documentation

API minimum functions

• Items
  • Create a new ERP item
    • Optional: Generating a new number based on an ERP numbering scheme
  • Update an existing ERP item
  • Read one ERP item
  • Search multiple ERP items with search criteria such as “contains”
• Bill of Materials
  • Create a new Bill of Material (only first level)
  • Update Bill of Material header information
    • Delete one ERP item from the existing Bill of Material
    • Update one ERP item of the existing Bill of Material
  • Read one Bill of Material header with Bill of Material positions (only first level)
• Documents
  • Upload a document to the ERP system as a binary
  • Update the metadata of a document in the ERP system
  • Update the document binary in the ERP system
  • Read the metadata of a document in the ERP

---

API documentation

Independently from the API type, we need API documentation for instance a word file.

API sample application

We need a sample application provided by the ERP team in order to ensure that the provided API works as expected.
All the required API functions (see above) and authentication must be shown, depending on the API type:

• For web services, in a Postman Collection
• For a .NET SDK, in a sample console application

Disclaimer

• The resources requested above are prerequisites for the continuation of the project
• The resources have to be provided by the ERP department of the customer/the ERP contractor of the customer as requested above.
• The project budget available to coolOrange only includes the handover meeting between the ERP side to coolOrange.
• In the handover meeting, the ERP department/contractor will present to coolOrange how to call each API function with a sample call, the same applies to the authentification. The presentation has to be made in the test environment provided by the customer.
• Any further engagement on coolOrange side to get the ERP API ready for implementation is not part of the project budget.

coolOrange Tasks

• Verify the received sample application from the ERP Team for instance in a Meeting. If we need to create the sample application then read "Initial Checks: ERP API Performance" to understand the best way for an test application"
  • mimic the customer workflow discussed with the API calls and verify the data in the ERP system
  • Comment test result here as comment
  • Write wiki about special and important behaviors
  • If an example is missing or something not working as expected then the ERP team must prove that the API works
• Copy a Plugin template for this ERP. For instance if a new ERP with REST service is used then search for reference in the internal wiki for templates
• Upload all resources to Github
• Add or remove tasks in ERP API Performance & Plugin development #176
• Start with the implementation of the integration issues by asking the Project Management