Getting Started with the REST API

Step 1 — Prerequisites and Setup

The following features must be enabled for your SuiteProjects Pro account to use the REST API.

Step 2 — Read the Relevant Documentation

This guide provides a reference for using the REST API. The guide is organized around the following conceptual topics for ease of reference:

• Supported Resources, Methods and API Features — Get a quick overview of what you can do using the API.

• REST API Known Limitations — Review the list of features that are only partially supported or not currently supported.

• Authentication — Ensure each API request must have the relevant authorization.

• OAuth 2.0 Authorization — Register client applications so they can use the OAuth 2.0 authorization code flow to access your company's SuiteProjects Pro account.

• Request Format — Review how to form your API requests.

• Response Format — Get an overview of the information returned in the API responses.

• Returned Data — Review what to expect in the data returned and how to include only what you need in the response data.

• Attribute Naming Convention, Data Types and Formats — Review the naming convention for resource attributes (fields), and the data types and formats used.

• Custom Fields — Review special considerations concerning custom fields defined for your company's SuiteProjects Pro account.

• Active Filter Set — Specify the filter set to be applied to your requests.

• Filtering — Build query expressions to retrieve the resources matching your search criteria.

• Pagination — Control the volume of data returned in the response and how to page multiple pages of data.

• Sorting — Sort a returned list of objects in ascending or descending order.

• Referenced Objects and Expansion — Expand object referenced by ID in the main response payload.

• Errors — Review possible API errors to handle errors programmatically in your client applications.

• API Limits — Review the API limits set for your company's SuiteProjects Pro account.

• Web Services Logs — Access log reports to audit API requests for your account, and troubleshoot your integrations.

• Generated API Documentation JSON — Access a generated reference document in OpenAPI 3.0 JSON format. The generated documentation includes account specific information such as custom fields.

This guide also include descriptions for each endpoints and methods for reference — See REST API Endpoint Reference. For account specific reference documentation, use Generated API Documentation JSON.

The business logic configured for your account may impact API requests and responses. Make sure you consult the relevant documentation, for information about SuiteProjects Pro business rules. For example:

• For a description of account global and application settings and access control mechanisms, see Administrator Guide and Security.

• For a description of optional features that may impact behavior, see Optional Features.

• For a description of user scripting, see User Scripting.

• For reference documentation about the SuiteProjects Pro database, see Database and the SuiteProjects Pro Data Dictionary.

Step 3 — Register an API Integration Application

The REST API supports OAuth 2.0 exclusively for authentication and authorization. An account administrator must register an application in SuiteProjects Pro and enable it before you can use the REST API. To register an application, go to Application > Global settings > API integration Applications and click Add new app. Note the client ID, client secret and redirect URI for the application. You will need this information to get the user’s permission and to obtain an access token. For more information, see OAuth 2.0 Authorization.

Step 4 — Test and Familiarize Yourself With the REST API on a Sandbox Account

You can use a GUI REST client to test and familiarize yourself with the REST API. A GUI REST client lets you:

• Make HTTP requests from a user-friendly interface instead of using a command-line utility such as cURL.

• Save your requests and other important information and reuse them again later.

• Get a new access token using the built-in GUI REST client functionality.

• Enter request information more easily and in the right format ( headers, query parameters).

• See the response in a prettified JSON view or a raw format.

This guide includes some guidelines working with the Postman desktop application to test the REST API. See Testing the REST API Using Postman.