WaveMaker Docs

WaveMaker Docs

  • Get started
  • Widgets
  • How-to
  • Enterprise
  • Releases
  • Blog
  • Sign-in

›Restful

Getting started

  • Introduction
  • Walkthrough

Pages

  • Pages Overview
  • Creating a Page
  • Layout and Styles

    • Page Layout
    • Templates
    • Themes

    Page Configure

    • Page Artefacts
    • Page Cache
    • Partial Page
    • Page Parameters
    • Examples

    Page Actions

    • Navigation
    • Events

    Custom Development

    • Theme Editor
    • Manual Theme
    • Create Template

Databases

  • Database Services Overview
  • Database Tools
  • Database Designing

    • Working with Databases
    • Data Modelling
    • DataBase Schema Modes
    • Working with DB Schema
    • Database Views
    • Temporal Support

    Accessing Database

    • Accessing Database

    Queries and Procedures

    • Working with Queries
    • Working with Stored Procedures
    • Version Queries & Procedures
    • Blob Queries and Procedures
    • Queries & Procedures - Java Services

    Database Variables & API

    • Database CRUD
    • Database APIs
    • Database Service APIs

REST & SOAP

  • Web Services Overview
  • Restful

    • REST Services
    • Secure Server-side Properties
    • REST Services using OAuth 2.0

    SOAP

    • Working with SOAP Services
    • Imported SOAP APIs

    Websocket

    • Working with WebSockets

    APIs

    • API Designer
    • Swagger Import

    Variables

    • CRUD Variable
    • Service Variable
    • WebSocket Variable

Java Services

  • Java Service
  • Java Services

    • Java Integration Services
    • DB Service Integration
    • Variables for Invocation
    • Generated REST APIs (API Designer)

    Java Services Variables & API

    • Variable for Java Service
    • Java Service APIs

    Source Files

    • Resources and Third-party Libraries
    • Using 3rd party JavaScript files
    • Using 3rd party jar files

Variables & Actions

    Variables

    • Variables Overview
    • Model Variable
    • Device Variables

    Binding

    • Variable Binding
    • Custom Formatter

    Actions

    • Actions
    • Navigation Action
    • Login Action
    • Logout Action
    • Timer Action
    • Notification Action

    Events

    • Events
    • JavaScript Access

Security

    App Security

    • Overview
    • Authentication
    • Authorization
    • Access Levels & Permissions
    • Login Configuration
    • Session Persistence
    • SSL Encryption
    • XSS antisamy policy configuration
    • OWASP
    • Central Authentication System
    • Token Based Authentication
    • SAML Integration
    • Secure Connection for Deployed Apps

    Security Variable and API

    • Security Variables
    • Remember Me
    • Variable for Security Service
    • Security Service APIs

Developer options

  • Test and Run (Preview) Apps
  • Build Options
  • Inspection Framework
  • Debugging
  • WaveMaker Mobile Apps Automation
  • Developer Integration

    • Project User Management
    • Developer Collaboration
    • Extending the Application using IDEs
    • Import, Export & Update Apps
    • Project Shells

    Add-ons

    • Localization
    • Artifacts Repository

Deployment

  • Overview
  • Deployment Profile
  • One-click Deployment
  • WaveMaker CI/CD Pipeline

    • Overview
    • Configuration Profiles
    • Pipelines and Phases

    Pipeline Configuration

    • Default Pipelines in WMO
    • Configure Pipeline in WME

    Deploy to Cloud Providers

    • AWS
    • Azure
    • Google Cloud
    • DigitalOcean

    Pipeline Configuration cont.

    • Phase configurations
    • Webhooks Integration
    • Tests Integration

    Manage Deployed Apps

    • Manage Deployed Apps

    Integrate with your CI/CD Providers

    • Push Code to External repo
    • Integration with Custom VCS provider
    • Export WaveMaker Application
    • Building Project with Maven
    • Build with Docker
    • Jenkins Integration
    • Deploy using Docker Compose
    • Deployment to Heroku

    WaveMaker apps Interation with CDN

    • App Integration with AWS CDN
    • App Integration with Azure CDN

    Deployment to external web servers

    • Application Server Overview
    • Deploy to Tomcat
    • WebSphere
    • JBoss - WildFly
    • WebLogic Server

Mobile development

  • Building Hybrid Mobile Apps
  • Native Device Support
  • First Mobile App
  • Mobile Design

    • Mobile Page Design
    • Gesture Support
    • Mobile Tabbar
    • Mobile Navbar

    Mobile Installer

    • Test Run (Preview)
    • Debugging Mobile Apps
    • Testing Hybrid Mobile Apps using WaveLens
    • Mobile Build - Android
    • Generating iOS and Android Distribution Certificates
    • Export Cordova zip
    • Mobile Build - Manual
    • Mobile Build - AppChef

    Mobile Integrations

    • Mobile Integrations - Amazon Mobile Analytics
    • Mobile Integrations - Amazon SNS
    • Using Push Notifications in Mobile Device
    • Invoking Web App APIs in Mobile Apps

    Offline Features

    • Offline Data Support
    • Implementation
    • Switching between Offline and Online Mode

Connectors

  • Introduction
  • Architecture
  • Import Connectors
  • List of Connectors
  • Build a New Connector

Teams

  • Overview
  • Team Setup
  • Dashboard
  • Manage Users
  • Manage Projects
  • Manage Roles
  • Code Repository
  • Team Profile
  • Manage Subscription
  • FAQs
Edit

3rd Party REST Services


While REST stands for Representational State Transfer, which is an architectural style for networked hypermedia applications, it is primarily used to build Web services that are lightweight, maintainable, and scalable. A service based on REST is called a RESTful service. REST is not dependent on any protocol, but almost every RESTful service uses HTTP as its underlying protocol.

Configuring API

WaveMaker allows configuring the following fields while importing a REST Service:

Method

A method can be GET, POST, PUT, HEAD, PATCH, or DELETE.

Url

The service URL hosting the REST service.

Use Proxy

Web Application

For Web Applications, while importing the service, Use Proxy flag can be turned off if you do not want to hit the service through the proxy server.

note

while testing the REST API without proxy if a CORS related issue is observed, you will be notified of the same and you can proceed only by enabling proxy.

Mobile Application

For Mobile Applications, there is no option to configure proxy settings. By default, the request made to the target REST service will be a direct hit. However, while testing the service in the WaveMaker, a direct call is made. If a CORS failure is encountered, then the call is made through proxy behind the scenes and the service is imported with the proxy as true for WEB. In the mobile app, however, the call will be a direct one.

Authorization

HTTP Authentication can be set to

  • None is the default setting
  • Basic can be used for basic authentication using a User Name and Password
  • OAuth 2.0 will allow you to integrate with an OAuth Provider. WaveMaker provides support for most OAuth providers. By selecting from the list, a semi-populated Configuration dialog is displayed. Complete the Configuration by giving the Client Id, Client Secret, etc. You can add a new provider too. Know more.

REST Configuration

Usually, the publisher of a REST service provides information on the input and output of the REST service. You can use that information to configure the REST service definition.

  1. The query parameters will be set as per the requirement of the REST service within curly brackets eg ?param = value and multiple query params separated by &, in the below example the origin and destination;
  2. The path param can be set by adding the parameter at the end of the URL within curly brackets ie {path_param}, and
  3. The header param can be set by adding the appropriate details like the parameter name and type.
note

These parameters can be seen as the Input Fields in the data section of the service variable when created and can be bound appropriately.

  • Response format can be edited to suit your app needs.

Following are the steps to import and use a REST web service within a WaveMaker app.

Test REST Service API

  1. From Resources choose Web Services and click the "+" button.
  2. From the Web Service dialog, select REST icon.
  3. Test.

For testing, do the following:

  1. Enter the REST service URL,
  2. Configure to set the HTTP Authentication and click Test to verify the response, proceed with the default setting of NONE.
  3. Configure the Headers for the name and test value parameters for the same
  4. Configure the query, path and header parameters etc. if needed.
  5. Click Import to proceed.
note

IMPORT button will be activated only on the success of the TEST.

Configure REST Service

  1. The new service created can be accessed from the Web Services under Rest Service section.
  2. Click on the service name listed under the Web Service section and the Service Settings are displayed.
  3. You can make changes to the service settings. Once you make the changes, Test the changes before saving them. This is particularly helpful when the REST service has undergone any changes or when it needs additional input parameters. You can see the Response Format from the REST service in the JSON format as required by the platform. Post ver 9.1 release, you can make changes to the Authentication option, too.

REST Services with Input Data

When importing REST Service which requires string or file as input, set the Content Type from Body tab to multipart/form-data to see the options for the Request Body parameters. The type of these parameters can be set to:

  • File for file or blob type data (Provision is there to upload a test file).
  • Text for string type data.
  • Text (text/plain) and JSON (application/json) for invoking WaveMaker generated internal REST APIs.

REST Service Usage

To use the Service data within the app, you need to create a Variable. See, Variable Access. In this article, we covered how to import and use a 3rd Party REST service in a WaveMaker app.

Last updated on 11/8/2019 by Swetha Kundaram
← Web Services OverviewSecure Server-side Properties →
  • Configuring API
    • Method
    • Url
    • Use Proxy
    • Authorization
    • REST Configuration
  • Test REST Service API
  • Configure REST Service
    • REST Services with Input Data
  • REST Service Usage
WaveMaker
  • PRICING
  • PARTNERS
  • CUSTOMERS
  • ABOUT US
  • CONTACT US
Terms of Use | Copyright © 2013-2021 WaveMaker, Inc. All rights reserved.