An API (application programming interface) is a set of rules that define how applications or devices can connect to and communicate with each other. A REST API is an API that conforms to the design principles of the REST (Representational State Transfer) architectural style.
The Showpad API is a RESTful client-server API, a software architecture that allows communication between clients and servers over the Internet using HTTP methods, with a focus on stateless interactions and resource-based URLs.
A resource is the core entity within the Showpad API. It is defined by an ID, a type, a collection of attributes, and a series of relationships connecting it to other resources.
All data created, updated, or retrieved via the Showpad API must be in JSON encoded with UTF-8.
In a basic REST API setup, a client sends an HTTP request to the Showpad server via a URL, which processes it and answers with an HTTP response. The URL identifies which resource or collection of resource links you want to access.
Showpad uses the following HTTP methods to map CRUD (Create, Retrieve, Update, Delete) operations to HTTP requests.
|Retrieves the representation of a single resource or a list of resources.|
|Same as |
|Creates or updates an instance of a resource.|
|Updates or replaces an existing resource.|
|Deletes an instance of a resource.|
Request headers are essential components that carry extra information within the HTTP header of a request, providing crucial details and configurations relevant to that particular request.
One key header parameter is
Content-Type, which specifies the data format being sent. They help both the sender and
receiver understand how to process and interpret the data.
The following table describes the available values for the
|Used to submit data in key-value pairs encoded as a URL string. Suitable for simple data updates.|
|Used to submit data in a structured format, including files. Suitable for uploading files or complex data.|
|Used to submit data in JSON format. Suitable for structured data that needs to be parsed and processed by the server.|
You can include parameters in your requests to control the returned data. Query parameters are attached to the end of the URL path. The following parameters are available for Showpad API:
|Limits the number of retrieved resources.||A |
|Offsets the retrieved Resource Links.||An |
|A comma separated list of attributes to be returned in the response. Typically used to make the response lighter.||Specifying |
Showpad uses conventional HTTP response codes to indicate the success or failure of an API request. In general:
Codes in the 2xx range indicate success.
Codes in the 4xx range indicate an error based on the information provided in the request. Errors can be caused by many factors, such as invalid parameters, authentication errors, and rate limits.
|OK||The request was successful.|
|Created||The resource was created.|
|Bad Request||The request is malformed.|
|Unauthorized||The request lacks valid authentication credentials.||An incorrect or expired OAuth2 access token was sent.|
|Forbidden||The request uses credentials that are not authorized for access.||Divisions are only accessible by division-enabled organizations.|
|Not Found||The requested resource could not be found.||Specifying an non-existent ID.|
|Method Not Found||Returned when an invalid HTTP method is used.|
|Conflict||The request conflicts with the current data.||Creating a user with a non-unique username.|
|Too Many Requests||Too many requests have been sent within a specific amount of time.|
|Internal Server Error||The server encountered an unexpected condition that prevented it from fulfilling the request.|