API Request

To make a REST API request, you combine the HTTP GET , POST , PUT , PATCH , or DELETE method, the URL to the API service, the URI to a resource to query, submit data to, update, or delete.

The URL to the API service is either:

Sandbox: https://sandbox-gateway.pingpongx.com Live: https://gateway.pingpongx.com

Optionally, you can include Query Parameters on GET calls to filter, limit the size of, and sort the data in the responses.

Most GET , POST , PUT , and PATCH calls require a JSON request body.

Query Parameters

For most REST GET calls, you can include one or more query parameters on the request URI to filter, limit the size of, and sort the data in an API response. For filter parameters, see the individual GET calls.

HTTP Request Headers

The commonly used HTTP request headers are:

Authorization

Required to get an access token or make API calls.

When you make a get an access token call, set the Authorization header to these credentials for the environment in which you're making the call.

A token enables you to complete actions on behalf and with the approval of the resource owner. Include the access token in the Authorization header with the authentication scheme:

  Authorization: <access_token>

Content-Type

The request format, which is required for operations with a request body. The syntax is:

  Content-Type: application/<format>

Where format is json .