If your system is not in the previous list, it's possible to include it easily! For more information to check if your system may be synchronized with this connector you do not hesitate to contact us through our [Contact form](http://www.soffid.com/contactform/)

You can visit the [Addons Getting started page](https://bookstack.soffid.com/books/addons-getting-started/page/getting-started) for more information about the installation process.

For more information about how you may configure the generic parameters of the agent, see the following link: [Agents configuration](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/agents "Agents")

Parameter	Description
Server URL	URL of the REST web service. Base URL for making calls.
Authentication method	Available options: - None: no authentication (User and Password are not used). - Basic: it uses the User and Password to generate the authentication token. - Bearer token: it is provided by the application to which we are trying to connect. - Token: generate a token from a specific authentication URL. It is no longer used. - Token oAuth Client Credentials: authenticates based on a client ID and a client secret. - Token oAuth Password Grant: authenticates based on a client ID and a client secret plus a user name and a password. (\) You can find more information in the [Authentication method](#bkmrk-%28%2A%29-authentication-m) section.*
Enable debug	Two options: "Yes", "No": it enables or not more log traces in the Synchronization Server log
Proxy host	Only when the proxy is needed.
Proxy port	Only when the proxy is needed.
XML Templates	Allows you to add new XML templates with SOAP requests and then configure them at attribute mappings.

Note that any changes made to the methods will affect the properties and vice versa.

Properties	Description
Path	A valid URL to call. This path must be the continuation of the Server URL for making calls.
Method	Available methods to call a Rest API (GET, POST, PUT, DELETE, PATCH)
Encoding	The specific type of encoded data that will be used. There are three supported types: - application/x-www-form-urlencoded - application/json - text/xml
XML Template	Applies only if it is text/xml. You need to write the name of the corresponding template defined on the XML Templates.
Parameters	Applies with application/x-www-form-urlencoded and application/json - You must type which attributes, defined on the System attributes, will be sent. - If none are to be sent, you must write the hyphen character "-". - If nothing is typed, all parameters are sent.
Success HTTP Codes	HTTP codes that should be interpreted as OK. If no code is entered, Soffid will take as valid codes the following: 200, 201, 204 and 404. If you type the Success HTTP codes, it will be not necessary to type the Failure HTTP codes. ```JavaScript 204 201 200 ``` ```JavaScript 200,212 ``` You can use blanks or commas to separate the codes.
Failure HTTP Codes	Soffid will take by default as failure all codes not indicated in Success HTTP Codes. If you type the Failure HTTP codes, it will be not necessary to type the Success HTTP codes. ```JavaScript 400 403 ``` ```JavaScript 403,405, 400 ``` You can use blanks or commas to separate the codes.
Results	Gets the object or object list from the response received. You need to indicate a JSON attribute name to check and get the data. If this element is not present, or empty, the connector will conclude the user does not exist yet. You can type simple attribute names or even complex scripts.
Pagination URL	Often, the response from the API Rest service does not contain all the data because the data is too large. In these cases, you can use the paging options to request the data in blocks. When the response gives us the URL of the next page to fetch, you must type the tag name of this attribute. ```JavaScript return links{"next"}; ``` You have to choose one of the paging methods, using both is not compatible.
Pagination script	Often, the response from the API Rest service does not contain all the data because the data is too large. In these cases, you can use the paging options to request the data in blocks. You can type a complex script to get the next call that has to be done. There are two available objects: - response: JSON response as received - request: allows you to update the attributes and return true if you want to make a new call or false in another case ```Java o = response{"paging"}; if (o{"has_next_page"}) { nextPage = o{"page_number"} + 1; request.put("page", nextPage); return true; } else { return false; } ``` You have to choose one of the paging methods, using both is not compatible.
Condition script	Return false if you want to prevent a call.
Optional header	Use this property to send HTTP header(s). More than one header can be sent by adding multiple properties Optional Header1. The value of the header is "HEADER:VALUE", for instance, "Accept:application/json".

**Properties**

**Description**

Path

A valid URL to call. This path must be the continuation of the Server URL for making calls.

Method

Available methods to call a Rest API (GET, POST, PUT, DELETE, PATCH)

Encoding

The specific type of encoded data that will be used. There are three supported types: - application/x-www-form-urlencoded - application/json - text/xml

XML Template

Applies only if it is *text/xml*. You need to write the name of the corresponding template defined on the XML Templates.

Parameters

Applies with *application/x-www-form-urlencoded* and *application/json* - You must type which attributes, defined on the System attributes, will be sent. - If none are to be sent, you must write the hyphen character "-". - If nothing is typed, all parameters are sent.

Success HTTP Codes

HTTP codes that should be interpreted as OK. If no code is entered, Soffid will take as valid codes the following: 200, 201, 204 and 404. If you type the Success HTTP codes, it will be not necessary to type the Failure HTTP codes. ```JavaScript 204 201 200 ``` ```JavaScript 200,212 ``` You can use blanks or commas to separate the codes.

Failure HTTP Codes

Soffid will take by default as failure all codes not indicated in Success HTTP Codes. If you type the Failure HTTP codes, it will be not necessary to type the Success HTTP codes. ```JavaScript 400 403 ``` ```JavaScript 403,405, 400 ``` You can use blanks or commas to separate the codes.

Results

Gets the object or object list from the response received. You need to indicate a JSON attribute name to check and get the data. If this element is not present, or empty, the connector will conclude the user does not exist yet. You can type simple attribute names or even complex scripts.

Pagination URL

Often, the response from the API Rest service does not contain all the data because the data is too large. In these cases, you can use the paging options to request the data in blocks. When the response gives us the URL of the next page to fetch, you must type the tag name of this attribute. ```JavaScript return links{"next"}; ``` You have to choose one of the paging methods, using both is not compatible.

Pagination script

Often, the response from the API Rest service does not contain all the data because the data is too large. In these cases, you can use the paging options to request the data in blocks. You can type a complex script to get the next call that has to be done. There are two available objects: - response: JSON response as received - request: allows you to update the attributes and return true if you want to make a new call or false in another case ```Java o = response{"paging"}; if (o{"has_next_page"}) { nextPage = o{"page_number"} + 1; request.put("page", nextPage); return true; } else { return false; } ``` You have to choose one of the paging methods, using both is not compatible.

Condition script

Return false if you want to prevent a call.

Optional header

Use this property to send HTTP header(s). More than one header can be sent by adding multiple properties Optional Header1. The value of the header is "HEADER:VALUE", for instance, "Accept:application/json".

Family	Description
Load	Used to retrieve all the objects in the target system
Select	Used to retrieve an object in the target system
Insert	Used to create an object in the target system
Update	Used to update an object in the target system
Delete	Used to remove an object in the target system

Process	Families
Reconcile automatic task	Load + select
Authoritative automatic task	Load + select
Sync new object	Select + Insert
Sync updated object	Select + Update
Sync deleted object	Select + Delete

**Process**

**Families**

Reconcile automatic task

Load + select

Authoritative automatic task

Load + select

Sync new object

Select + Insert

Sync updated object

Select + Update

Sync deleted object

Select + Delete

You can find more information by visiting the [Properties attributes page](https://bookstack.soffid.com/books/connectors/page/json-rest-web-services-connector-properties).

For more information about how you may configure attribute mapping, see the following link: [Soffid Attribute Mapping Reference](https://bookstack.soffid.com/link/72#bkmrk-soffid-attributes)

To view some examples, visit the [Outgoing triggers examples page](https://bookstack.soffid.com/books/connectors/page/outgoing-triggers-examples "Outgoing triggers examples").