New API Error Format in 8.0

RPM 8.0 is bringing a change in the way errors in API results are structured.

On previous versions of RPM, when a call generated an error the response looked like this:

{
	"Result":{
		"Error":"Valid key required"
	}
}

The new syntax that you will be getting in 8.0 the value for the Error is an object.

{
	"Result":{
		"Error":{
			"Message":"Process not found"
		}
	}
}

This will allow us to provide you with more information on the error in the future. For now, any code that interacts with our API should take this into consideration and update the handling of error response.

Tagged with: , , ,
Posted in API News

Upcoming Change: Key goes First

On an upcoming update to RPM, the system will start requiring that the key be the first piece of data to be present in the request data.

Like this:

{
    "Key": "<Your API Key>",
    ... <"Rest of the Request Data>
}

The reason for this change is to optimize resource usage by not having to parse the entire request if the key is incorrect.

If you don’t do this already, we recommend that you do as it will not affect the way requests works at the moment and will ensure future compatibility when this requirement starts to be applied.

Posted in API News

Welcome to RPM’s Developers Site

Hi and Welcome,

Today We’re thrilled to launch this developers site. We plan to use it for documenting the current state of the REST API that comes with every RPM subscription as well as to keep developers informed of future changes that we have planned.

As we continue our progress in documenting all the available API endpoints, we will also start building sample applications and wrappers to show how to use them in different programming languages. If you have any questions, or requests please get in touch with us.

Posted in RPM