Working with the API

To access the endpoints you require 2 things that will be provided by GlobalVision: API Key and Org ID.

Both of these parameters are necessary whenever interacting with the API.

Flow of events

To use the API the typical flow is as follows:

1. Upload the files that will be inspected
2. Submit a job for the desired inspection
3. Poll for the results of the job

Step #1 may not be required if you're running an inspection for a file that has been previously uploaded.

Uploading files

The API needs access to the files used in the inspection. There are 2 ways of doing so:

1. Uploading them via the Storage API
2. Creating a resource so that the system can read from the custom location

Sumit a job

A job can process 1 to N files, however, keep in mind that once you're retrieving the result of the job you will need to handle pagination.

For details on how to submit a job please refer to the documentation

Poll for results

Once a job is submitted, you will get back a jobId which should be used to poll for the results.

For more details please refer to the documentation