Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Current »


Collection Summary

ipushpull have created a Postman collection to help aid development understanding. The collection contains two examples and the endpoints to interact with both non-structured and structured pages.

To download the Postman application use this link - https://www.getpostman.com/

Contents of the collection is as follows:

  • Non-structured page Example

  • Structured page Example

  • Endpoints - List of all endpoints used above and additional ones that may be useful for developers.

Installing the ipushpull Postman collection and setting up an environment

The following steps will guide you through importing the collection and initial setup to use the examples.

  1. Download the ipushpull Postman collection

  2. Import the ipushpull collection via File → Import, you should then see the collection in your list:

  3. Create an environment via File → New, select environment

    • Give the environment a name e.g. Sandbox

    • Add the following variables, note enter values under Current Value to keep sensitive data on your local PC only:

Variable

Current Value

URL

This should be the URL of the sandbox environment you have been given e.g. https://test.ipushpull.com

CLIENT_ID

Supplied by support@ipushpull.com, please contact support if you do not have this.

CLIENT_SECRET

Supplied by support@ipushpull.com, please contact support if you do not have this.

IPP_USERNAME

Your ipushpull user that you use to login

IPP_PASSWORD

Your ipushpull user’s password

Running the Examples

  1. Select either the non-structured page or structured page example

  2. Using the Example - Non-structured Page you will see the following:

  3. Click each item in order:

    • Authenticate

    • Create Test Folder

    • Create Non-structured Page

    • Push content to the page

    • Update content on page

    • Pull page content

    • Logout

  4. The page can also be viewed from within the Web application by selecting the TEST_FOLDER and opening the page.

All example endpoints and additional endpoints can be found in the Endpoints folder. These have been grouped in to relevant functionality.

  • No labels