Skip to main content

File Callback API

1. Overview​

File Callback API provides suppliers access to order documents without having to upload them as attachments in Jakamo. To utilize this functionality, provide an API that can respond to queries with the following format:

GET [base_url]/materials/documents?materialId=[item_id]&revision=[revision]

File Callback API Usage​

The usage of the File Callback API depends on the capabilities of the client's system and the integration developer.

Case 1:​

  1. Jakamo authenticates itself with the PDM system.
  2. The PDM system returns all data related to the specified item to Jakamo.
    • Jakamo does not verify the accuracy of the drawings. It is the client's responsibility to ensure that the PDM system's data is correct.
    • All supplier users can view the specified document information related to the items in the orders within the customer relationship.

Authentication occurs through the order via Jakamo. External parties cannot view the information behind the PDM link; only the buyer and seller involved in the order have access.

Example:

https://www.example.com/api/v1/materials/documents?materialId=55-554354&revision=120 would fetch files for item number 55-554354 revision 120.

The revision parameter is optional. If a revision parameter is not provided, the latest revision should be returned.

Expected data format:

{
   "data":[
   {
      "fileName": "File1.pdf",
      "description":"File1",
      "type":"Drawing",
      "link": "https://www.example.com/api/item/55-554354/file1.pdf"
   },
   {
      "fileName": "File2.xml",
      "description":"File2",
      "type": "Specification",
      "link": "https://www.example.com/api/item/55-554354/file2.xml"
   }
   ]
}

Links should point to the same base domain as the initial query and have the same authentication method.

2. Authentication​

API key authentication in a header is currently supported. Both the file listing query and the actual file fetching should use the same authentication method.

3. Api reference​

Full api reference in open api 3.0 format available at: File callback api reference

Help & Support

Didn't you find what you were looking for? Send an email to Jakamo support (support@thejakamo.com) and we will help you.