PHP - Rest-based Card Clearence

<?php
              $myData = file_get_contents("");
              $myObject = json_decode($myData);
              $myObjectMap = $myObject->result;
            ?>

can i somehow build in that it only request every 5 minutes because if there are many users on the site it request too much?

Here is the scenario.

I created a niche market API which provides environmental data.  The data is obtained by industrial controllers which don't monitor anything by default, and the API has additional endpoints which are used to instruct the industrial controllers to start monitoring some parameter so the API can then start storing the trend data.  The API primarily responds with JSON, however, a couple of endpoints support CSV data.

For humans/webclients to access the data, I also created a webserver application which can be added to a Concrete5 (C5) CMS.  I tried to make as many of its endpoints do nothing except receive the webclient's request, add a JSON Web Token to it which contains a unique identifier, forward it to the API using cURL, and return the response as is to the webclient.  To limit the scope which needed to be created for the C5 application, the API has endpoints to return JSON which is used by JavaScript on the webclient for client-side validation, endpoints (actually, a different domain) to return static JavaScript/CSS/etc, and endpoints to restructure the JSON data to some more suitable format.

I now am looking at creating different applications which does not use C5, but either are 100% custom or use some other CMS such as Drupal, etc.  While I tried to limit the scope implemented on the C5 application, I have much more than I desire and will need to duplicate much for any future application.  The primary scope I would like to remove from the webserver application relates to the HTML views and consists of templates which create HTML from JSON, the JavaScript which interacts with the HTML, and to a lesser degree controllers to determine the type of view (i.e. a list of records or one specific detail record).

While the API will only be managed by myself, the intent is that the C5, 100% custom, etc webserver apps are installed and managed by others. 

Ideally, there is some existing Composer package for transforming JSON to HTML which is CMS agnostic, however, I don't know whether such exists.  Also, while not 100% necessary, ideally this functionality could exist on my server and not the individual web application's server.

Whether I build it myself or use some existing package, I expect it will need to do something like the following:

The various webserver apps will have some routing table to proxy the request either to my JSON API server (complete) or my new "HTML API Server" (remaining discusses this portion).

This HTML API server would generate the content either by making a cURL request to the main JSON API, or better yet since likely located on the same server have routing functional to make direct calls to the JSON API's methods, and return something like the following:

{
    "html": "<div>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Pharetra massa massa ultricies mi quis hendrerit dolor. Leo integer malesuada nunc vel risus commodo viverra.</div>",
    "javascript_files": [
        "https://resources.myserver.com/someFile.js",
        "https://resources.myserver.com/someOtherFile.js"
    ],
    "css_files": [
        "https://resources.myserver.com/someFile.css",
        "https://resources.myserver.com/someOtherFile.css"
    ]
}

The various applications would then take the HTML and resource files and insert them using their proprietary methods. 

EDIT.  Also, thinking of using an IFRAME, however, definitely have concerns with doing so.

My day job has nothing to do with software, however, am hoping to make it so.  Before embarking on this task, I would like to know whether some existing framework exists and if not what general strategy (organization, caching, etc) I should take to develop it.

Thanks

I have the following tables:

I also have the following REST API endpoints:

The user should be informed before deleting a given record if that record will affect other tables.  For instance, if deleting a department which has some courses or deleting a student which belows to a course.

One option is to respond to DELETE department/123 with 400 {recordUsed: {courses:[bla, bla], student_courses:[bla, bla]}} if used.  For this option, the client would then prompt the user of the implications and if desired repeat the request but include a "force" parameter of TRUE in the request which will delete the record regardless of being used.

Another option is to add some new endpoints which will return the resources which are associated with the to be deleted entity.  If empty, a DELETE request would automatically be made and if not empty the user will first be prompted whether the DELETE request should be made and the server would delete the record(s) regardless of being used.

Any thoughts on which approach should be used?  Or maybe some other strategy?  Thanks

I actually have two parts to this post.  One which describes just my understanding on how a multipart request should look with a REST API and gives a little context, and the second how to actually implement it using Sympony and api-platform.

Part 1

Looking to simultaneously upload a file, some file meta data, and identifier of the uploading user to a REST API, and will do so using a multipart request.

Based on swagger, looks like the request should look something like the following:

POST /upload HTTP/1.1
Content-Length: 428
Content-Type: multipart/form-data; boundary=abcde12345
--abcde12345
Content-Disposition: form-data; name="id"
Content-Type: text/plain
123e4567-e89b-12d3-a456-426655440000
--abcde12345
Content-Disposition: form-data; name="address"
Content-Type: application/json
{
  "street": "3, Garden St",
  "city": "Hillsbery, UT"
}
--abcde12345
Content-Disposition: form-data; name="profileImage "; filename="image1.png"
Content-Type: application/octet-stream
{…file content…}
--abcde12345--

Background noise... The above example shows three parts which include the text ID, JSON address and octet-stream file.  Doing so doesn't make sense to me and I will probably just have two parts for the meta data JSON.  Note that potentially, I will be removing the user from the JSON payload and including it in some JWT header.  Also, showing resources as links such as /api/users/1 in the request and response JSON is new to me, but I guess makes sense.

Regardless, my meta data JSON will look like:

{
    "projectId": 1234,
    "documentDescription": "bla bla bla",
    "specification": "230903.2.4.D",
    "user": "/api/users/1"
}

and the response will look like:

{
    "projectId": 1234,
    "documentDescription": "bla bla bla",
    "specification": "230903.2.4.D",
    "uploadAt": "2021-01-27 08:41:17",
    "fileName": "pressuresensor.pdf".
    "user": "/api/users/1".
    "file": "/api/uplodaed_files/1234"
}

Am I somewhat going down the right path?

Part 2

Wow, should have looked into Sympony before now!  Entities, validation, the API, etc were a breeze.  Still confused with some of the "magic", but understanding what is under the hood more and more.

As stated initially, I am utilizing api-platform and am looking at api-platform's file-upload.

I guess the first question is whether my POST request with both the file and JSON meta data can be performed in a single request.

Per making-a-request-to-the-media_objects-endpoint:

Your /media_objects endpoint is now ready to receive a POST request with a file. This endpoint accepts standard multipart/form-data-encoded data, but not JSON data.

What?  Am I reading this correct?  Do I first need to make a multipart requests using either a standard HTML form or a XMLHttpRequest which just sends the file, receive the document locator, and then send a second request with the location and my meta data?

If so, I guess I have enough to go forward.  I would rather, however, perform the work in a single request.  My previous mentioned swagger multipart-requests shows both in the same request.  symfonycasts's api-uploads also describes doing so, but not with api-platform.  Is there a way to do so with api-platform?  Does it make sense to use api-platform for all other routes but then make a custom route for document with meta data uploads?  Any recommendations are much appreciated.

Thanks