Getting started in the dashboard
To access an API for the first time, you will need a subscription key:
Go to the Products tab in the menu bar
Click on the product you want access to
Request a subscription key by entering a name for your subscription key and clicking the ‘Subscribe’ button
Once your request has been approved, you will be notified by email. You may now begin using the API:
Return to this dashboard and access the API in one of three ways: by clicking the 'Explore APIs' button on the Home page, by clicking the APIs link in the menu bar, or by clicking the API link on the Products page
You will be brought to the API details page where you can view information about the endpoint, including the request URL and request parameter
Click the green 'Try it' button on the right side of the screen
Enter the GSA number you want to verify
The Ocp-Apim-Subscription-Key field should already be populated with a hidden key; if it isn't, you have not requested your subscription key yet (return to the section above)
Click the 'Send' button
You will see one of three responses: {
"Certified": "true"}, {"Certified": "false"}, or {"Alert": "Invalid GSA number entered. Please enter a valid GSA number."}
Using the endpoint outside of the dashboard
You will need to provide the subscription key in the header of your request:
Ocp-Apim-Subscription-Key: {subscription key}You will need to include the GSA number as a parameter in the request URL: https://prism-connect.globalseafood.org/api/v1/certified/{gsa_number}
Contact us
Please contact us at itdept@globalseafood.org if you have any questions.