API Documentation

This document is a work in progress and your opinion helps us to improve. Please let us know what we can do better. Thanks! support@procurios.com

Getting support for the Procurios API

At some point, while working with the Procurios API, you may run into unforeseen issues. This page gives you some pointers on what to do if you find yourself stuck.

First of all, remember you can test methods directly from our documentation, and you can also inspect the logs for any calls you made from either the tester or your own code there. For more on that, check the Getting Started section here.

In some cases that isn't enough and you need direct help. In those cases, there are two parties that might be able to support you: either Procurios (developer of the API) or your client (manager of the API).

Issues

This page will help you decide where to go, and what that party might need to help you further. We've split issues into a few categories:

The API returns broken or missing data

Your calls are not returning the data you expect, or no data at all. The structure you receive matches the one in the documentation, it's just that the fields are empty.

These situations are likely caused by a misconfiguration or because no test data is loaded in the implementation. They can be resolved by the client, and these problems should be directed to your contact there.

API requests or responses do not match the documentation

If you spot any errors in this documentation, including your request or response having a different structure from what's shown in the documentation, please let us know.

There's a "feedback" button in the top right corner of every page. Please check the "How to send good feedback" section below to see how you help us fix the problem the fastest!

We will modify the docs to match the actual structure, so in the meantime you can use the structure you see instead of the one in the documentation.

The API is returning http 5xx errors

These are probably errors on our end. We'd like to apologize for those!

If you are getting a 500 or 501 error, please use the "feedback" button at the top-right of the page to let us know about it. You can check the "How to send good feedback" section below to see what we need to look into your issue.

If you are getting a 502 or 503 error, please try again later. We monitor those automatically, and they probably have nothing to do with your most recent calls.

We need data that the API does not have available

There is a lot of information in the Procurios system. Not all of it can be returned by the API.

If you need information that is not available according to the docs, you should check with your client first. A lot of information can be made available by them through configuration or permission management.

If the information cannot be made available through configuration, that means we need to modify the API. This process also goes through the client first. Update them on what you need, and we'll discuss options with them. If custom API updates are made specifically for one client, it is possible that we'll schedule a meeting with you and them to discuss options and agree on what modifications are needed.

How to send good feedback

This is a quick guide on what you should include with your feedback to maximize our ability to make the API better.

A good feedback message should always include the following:

  • Your company name
  • The name of the shared client we are both working with
  • The API method (preferably the full URL you called)
  • A ProbaseRequestId that shows the issue
  • What you expected to happen based on the docs
  • What happened instead