REST Integration

 REST - REpresentational State Transfer.

It can accommodate - XML, JSON, HTM, Plain Text.

Rest uses HTTP methods to interact with the remote system. These include

 GET - To read a resource.

POST - To create a resource.

PATCH -  Update the specific value in the record.  (Can send only the data needed to be updated, no need for full data)

PUT - Update an existing resource or create a new one if needed. (Need to send all info)

DELETE - To remove a resource. 

These deal with how data is passed to the REST API :

Query parameters:

Path parameters:

Headers: 

Request Body: 

We have the inbound API's in the REST API Explorer.

We can create the custom API's in the Scripted REST API. 

 Scripted REST API:

 A Good plan 

1. Purpose.

2. Inputs. (Path Parameters, Query Parameters, Request Body(Used input, post, and patch))

3. Outputs.

4. Security for API.

Requires Authentication, Requires snc_internal Role, ACL ( type = Endpoint).

5. Versioning:

Maintain multiple versions of an API endpoint without affecting existing systems. 

Advantages of Scripted REST API,

Can give custom Inputs, Custom Processing, and Custom Payload.