Getting Started with the Site Flow API

About

SiteFlow has a number of available API’s that are RESTful HTTP based API’s. Where possible, we have exposed resource-oriented access using standard HTTP verbs and respond with standard HTTP status codes.

When communicating with the API directly, JSON will be returned in all responses including errors. If you are using one of our SDKs, the SDK will transform the JSON responses into language-specific Site Flow objects.

Any off-the-shelf HTTP client written in any language should be able to access the API easily.

API Documentation

The various endpoints and their capabilities are documented on the Site Flow API Documentation

Testing the API

If you are looking to test API calls to Site Flow you can visit the Site Flow Test page.

SDKs

The Site Flow API can be also consumed using one of our existing SDKs:

LanguageURL
Javascripthttps://github.com/HPInc/oneflow-sdk-js
.NEThttps://www.nuget.org/packages/OneFlowSDK/
PHPhttps://github.com/HPInc/oneflow-sdk-php
Rubyhttps://github.com/HPInc/oneflow-sdk-ruby

Error handling

Generally speaking, for 400 errors, the error response will be in a JSON structure as shown below:

{ 
"success": false, 
"error": { 
     "message": "Couldn't find a thing with that ID", 
     "name": "NotFound", 
     "code": 404 
     } 
}

The Site Flow API returns a JSON error along with one of the following error codes:

Error codeMeaning
400Service Unavailable – We’re temporarily offline for maintenance. Please try again later.
401Unauthorized – Your API key is wrong
403Forbidden – Your API key doesn’t allow access to this resource
404Not Found – The specified resource could not be found
500Internal Server Error – We had a problem with our server. Try again later.
503Service Unavailable – We’re temporarily offline for maintenance. Please try again later.