API Access Integration

Last updated
Save as PDF

The OWS API Access feature allows users to easily pull data from OWS including user data and POS data or tickets. Once enabled, administrators can create an integration for API Access in OWS. This feature is currently only available to specific customers on request.

API Access Integration

Add API Access

In OWS, click on Management > Integrations.

Management Integrations Dropdown.png

Select Integrations.
Click the Add New Integration button.

Add New Integration Button.png

Select API Access and click Next.

API Access.png

NOTE: Integration Management is not available for all End User account types.

Authentication

Creating an API Key

Select the Management tab.
Choose Integrations from the drop-down menu.
Choose the API Access Integration.

API Access Added.png

Select Add Key in API Access Keys.

API Access Keys.png

Select which items from the list the Key will have access to.

API Key w PoS.png

Copy the API Secret Key from the dialog box.

API Create New Access Token.png

NOTE: If the secret key is lost, a new API access token must be created.

Click Save to close the dialog box.

API Secret Key.png

Making Requests

To make a successful request, a request to any of the API Access endpoints (listed below) must contain an Authentication header with a value of: X-API-Key AKI={API Access Key};AKS={Secret Key}

As long as this header is present, has valid values, and the API Access Token isn’t disabled, the request will successfully authenticate. Users should use the API Access URL at the top of the API Access Integration page to access the API. That URL will prefix the below endpoints.

Existing Endpoints

API URL	RETURN OBJECT	OPTIONAL PARAMETERS	NOTES
/apip/users	{ “content”: [ { “firstName”: “Tester”, “lastName”: “User5”, “emailAddress”: “test@user5.com”, “userGroups”: [ “Administrator”, “Custom Group 2”, “Custom Group 3” ], “createdDate”: 1571863236000, “lastSignInDate”: null } ] }	This endpoint accepts an optional i parameter for paging. i=0 in the query string corresponds to the first page of data. Each page of data is limited to 100 users. If the i parameter is excluded, the first page of data will be returned.	If the user isn’t assigned any usergroups, the usergroup node will be null. The dates are returned in microseconds from epoc
/apip/cpos	{ “content”: { “posTicketsEndpoint”: “https://Z6WGRN-ex.cpos.gribblepack.net/apip/tickets” } }	No additional params	This API is called that will return a tenant scoped API to access POS Connect directly.
{cpos}/apip/tickets (or posTicketsEndpoint) IE: https://Z6WGRN-ex.cpos.gribblepack.net/apip/tickets	{ “content”: { “cursor”: “MTYzMzQ4MDI4MDAwMDAwMCYxNjI5NDc2NDA0NzgyaVjBfQ3FIU2JlR0p...”, “resultCount”: 50, “results”: [ {PosTicket...}, ... ] } }	startDate - micro epoch seconds for when to start searching for tickets endDate - micro epoch seconds for when to stop searching for tickets cursor - used for paging if additional results are present maxPageSize - optional for setting the page size returned (cannot be greater than 50) Param note: API will use startDate and endDate OR cursor. After the initial search with startDate and endDate, cursor is the only param required. Data is exhausted when the cursor is null/empty string. There can be empty results between pages of data (request 1 might have 50 results, request 2 could have 0, and request 3 could have 25, etc).	Start and end date both use persist_date instead of start_date internally. Meaning the results returned by this API will be when the tickets got sent to us, not when the tickets got rang up by an operator. This is to ensure all tickets get returned as tickets that get sent to us may have a start_date of any number of days/weeks in the past. Using persist_date, we guarantee all tickets are returned. Postman Collection Export for Integrators: Point of Sale Ticket List Integration.postman_collection.json

API URL

RETURN OBJECT

OPTIONAL PARAMETERS

NOTES

/apip/users

{
“content”: [
{
“firstName”: “Tester”,
“lastName”: “User5”,
“emailAddress”: “test@user5.com”,
“userGroups”: [
“Administrator”,
“Custom Group 2”,
“Custom Group 3”
],
“createdDate”: 1571863236000,
“lastSignInDate”: null
}

]

}

This endpoint accepts an optional i parameter for paging.

i=0 in the query string corresponds to the first page of data.
Each page of data is limited to 100 users.

If the i parameter is excluded, the first page of data will be returned.

If the user isn’t assigned any usergroups, the usergroup node will be null.
The dates are returned in microseconds from epoc

/apip/cpos

{
“content”: {
“posTicketsEndpoint”: “https://Z6WGRN-ex.cpos.gribblepack.net/apip/tickets”
}
}

No additional params

This API is called that will return a tenant scoped API to access POS Connect directly.

{cpos}/apip/tickets (or posTicketsEndpoint)

IE:
https://Z6WGRN-ex.cpos.gribblepack.net/apip/tickets

{
“content”: {
“cursor”: “MTYzMzQ4MDI4MDAwMDAwMCYxNjI5NDc2NDA0NzgyaVjBfQ3FIU2JlR0p...”,
“resultCount”: 50,
“results”: [
           {PosTicket...},
           ...
       ]
}
}

startDate - micro epoch seconds for when to start searching for tickets
endDate - micro epoch seconds for when to stop searching for tickets
cursor - used for paging if additional results are present
maxPageSize - optional for setting the page size returned (cannot be greater than 50)
Param note: API will use startDate and endDate OR cursor. After the initial search with startDate and endDate, cursor is the only param required. Data is exhausted when the cursor is null/empty string. There can be empty results between pages of data (request 1 might have 50 results, request 2 could have 0, and request 3 could have 25, etc).

Start and end date both use persist_date instead of start_date internally. Meaning the results returned by this API will be when the tickets got sent to us, not when the tickets got rang up by an operator. This is to ensure all tickets get returned as tickets that get sent to us may have a start_date of any number of days/weeks in the past. Using persist_date, we guarantee all tickets are returned.

Postman Collection Export for Integrators: Point of Sale Ticket List Integration.postman_collection.json

API Access Integration

Add API Access

Authentication

Creating an API Key

Making Requests

Existing Endpoints

Related Links