Next, let’s take a look at the other tabs and settings that are available to you in the Edit Method view.
Rate Limits
If you have already set up rate-limits at Connector-level you do not necessarily need to set them at method-level. However, if you ever need to add method-level rate limits, here is where you can add them.
Overriding Connector-level Rate Limits
Method-level Rate Limits have an additional option called “Override Connector Rate Limits?“
When enabled, Cyclr will ignore any Connector-level Rate Limits for that particular Method, and only use Rate Limits defined at the Method-level. If no Rate Limits have been set at the Method-level, no rate limiting will occur, resulting in Cyclr making calls to that Method as quickly as it can.
Calls to Methods with the “Override Connector Rate Limits?” option enabled won’t count towards any other Rate Limits of the Connector, so it won’t impact the usage other Methods.
Request Format
If you are sending data in our request body (e.g. ‘Create’ or ‘Update’ requests), you will need to determine the fields that the API can expect to receive. You can do this in the ‘Request Format’ tab.
Click the “Add field” button and type in the name of the field you want to be able to amend, and click on “Create”. Note that the capitalization of the field name has to be identical to the field in the server.
You will notice Cyclr will automatically generated values for the ‘System Field’ and ‘Display Name’ based on the name you provided for the field. If they don’t look right, you can still edit them by clicking on the pencil icon next to each field.
Complete the available fields:
- Connector Field is the name of the field in the response, this has to be identical to the response from your server. This is how Cyclr knows where to place the data in the request.
- System Field is the internal name Cyclr uses to map the data. This should be formatted in PascalCase (each word has a Capital letter, but no spaces or symbols are permitted).
- Display Name is the name Cyclr’s users will see. It should use spaces and capital letters for each word. Abbreviations (VAT, ZIP, ATH, BTC) should be capitalized.
- Description is an optional description for the field. This is visible to users.
- Data Type is the type of data the API should expect to receive for that field. You can choose one of these from the drop down menu:
- Text (string)
- Integer
- Float
- Boolean
- DateTime
- File
- Decimal
Response Format
If you want to receive data in your method’s response body, you need to map all the data fields in the ‘Response Format’ tab.
Click the ‘Add Field‘ button and type in the name of the response field you want to set. This has to be identical to the response from the server. Click on ‘Create’, and complete the available fields, similarly to the Request Format above.
Data Types
Both for Request and Response Formats, you have an option to choose which Data Type you will be using. This is different from the data type that you select for the objects in your Request and Response format fields, as this retains to the entire Request/Response.
Cyclr will have selected JSON as a default, but you can also set your Method’s Request and Response Formats to another Data Type that you know you will be sending or receiving from the API. This could be XML, PlainText, File, etc.
You can read more about the available data types in our Documentation.
Auto-Generating fields for Request and Response Format
If you have an example of the request or response format you will send to or receive from the API, you can utilize the ‘Generate Fields’ function available behind the ‘More Actions’ button.
Click on the ‘More Actions’ button, and select ‘Generate Fields’. Copy the entire example request or response and paste it into the Generate Fields text box.
When you click on Submit, Cyclr will auto-generate all the fields provided in the text box, complete with the data type that it has detected. This can take a minute depending on how many fields you are generating.
You can adjust the fields afterwards just like with manually added fields.
When you make any changes, remember to always click the ‘Save’ button on the settings panel to save your progress.