Open the iAPI application. Then, use the fields described below to run API calls based on the data you provide in a CSV file. [block:image] { "images": [ { "image": [ "https://files.readme.io/76f6c8d1e72d47ea7e187bd28e9fa67e25124ad74bf6dbbad6b5bac281e96f07-image.png", null, "iAPI application user interface - Some text intentionally blurred" ], "align": "center", "caption": "iAPI application user interface - Some text intentionally blurred" } ] } [/block] > 💭 Example: Basic iAPI workflow > > 1. Open iAPI. > 2. Enter your Orange Logic URL. > 3. Authenticate by entering your username and password or by logging in with SSO. > 4. Attach your CSV file. > 5. Select the CSV encoding format. > 6. Enter an API call. > 7. Enter the row number of the data you want to process first. By default, the line is 2 because line 1 is the header. > 8. Click **Test Next Record** to test the call. > 9. If the test was successful, process the CSV file. If the test was not successful, check out these [tips and troubleshooting](ref:tips-and-troubleshooting) recommendations. > > [block:image]{"images":[{"image":["https://files.readme.io/388caecdb41113e5b138debd80b024bd7cedc3974b4195b0aa46b130b16f8860-image.png",null,"Process a CSV File"],"align":"center","caption":"Process a CSV File"}]}[/block] ## Base URL Enter the URL of your Orange Logic environment in the **Base URL** field. The URL must include the **https\://** prefix. We recommend you copy the full address directly from the browser window to ensure this URL is correct. ## Authentication options To make API calls with iAPI, you must be logged in to your Orange Logic environment. There are several methods to log in: - [Log in with your Orange Logic credentials](#log-in-with-your-orange-logic-credentials) - [Log in with SSO](#log-in-with-sso) - [Log in with your Windows credentials](#log-in-with-your-windows-credentials) > ℹ️ Note > > A user who authorizes iAPI must still have the [necessary security functions and permissions](ref:api-testing#orange-logic-security-functions-and-permissions) to run individual calls. > > Orange Logic administrators working in the Orange Logic interface can verify that a user has authorized iAPI, and remove the authorization if needed, by opening the user’s account and clicking **Internal authorized applications**. > > [block:image]{"images":[{"image":["https://files.readme.io/4c0e7d0c252c00d0f8a421789c704bc40e8b37f348e3b6ffe0c72f421bb240be-image.png",null,"Internal authorized applications"],"align":"center","caption":"Internal authorized applications"}]}[/block] ### Log in with your Orange Logic credentials Your credentials in iAPI are the same as your credentials for the Orange Logic interface. [block:image] { "images": [ { "image": [ "https://files.readme.io/369dee39dffa9b9c260f05c9e450d12dc3c75dec434d027973e05a10138b5f18-image.png", null, "Orange Logic credentials login" ], "align": "center", "caption": "Orange Logic credentials login" } ] } [/block] If you are unable to log in, verify that you entered a valid, secure link in the [Base URL](#base-url) field. ### Log in with SSO If you use SSO to log in to the Orange Logic interface, click **Login with SSO**. [block:image] { "images": [ { "image": [ "https://files.readme.io/64a47d1eeff33829f357bf3a647a202d28b77397ee4d9dd71088d3f41a71c1a7-image.png", null, "Login with SSO" ], "align": "center", "caption": "Login with SSO" } ] } [/block] You’ll be redirected to the Orange Logic login page in your browser (if you’re not already logged in) and then to a page where you can authorize iAPI access to your environment. [block:image] { "images": [ { "image": [ "https://files.readme.io/9f226cfb95f4aaa4fd733bccb5abaac0d6989792d98b67c7883761754e4fd95c-image.png", null, "Authorize iAPI" ], "align": "center", "caption": "Authorize iAPI" } ] } [/block] ### Log in with your Windows credentials If you use the same SSO credentials for your Windows computer and Orange Logic, select the **SSO Login (Use current Windows credentials)** checkbox to automatically populate the **User name or email** and **Password** fields. Then click **Login**. [block:image] { "images": [ { "image": [ "https://files.readme.io/5cbccd5dc8e6812a370d5ac3cd1f1bbab3f0eda15e834c1fcc2057cacd98fe68-image.png", null, "Windows SSO login" ], "align": "center", "caption": "Windows SSO login" } ] } [/block] ## Select your CSV file Before you run an API call, you must upload the CSV file that contains the data you want to ingest. - Click **Select file** to upload a CSV. To switch from one CSV to another, close and reopen iAPI. - See our [tips and troubleshooting](ref:tips-and-troubleshooting) recommendations for details on which characters are allowed in iAPI CSV files. [block:image] { "images": [ { "image": [ "https://files.readme.io/25efb54f8509b0d6ad7388638fe383b1de5e78ed8a487d91e3012a457068911d-image.png", null, "Select file (.CSV)" ], "align": "center", "caption": "Select file (.CSV)" } ] } [/block] > 💡 Tip > > Remember to review all your settings when you change from one CSV to another. When you run a call on a new set of data, verify details such as the [placeholders](#use-placeholders) in your call and the [starting row](#select-a-starting-row) , and be sure to [test a few rows](#run-a-call). ## Specify CSV file encoding Choose the encoding method that matches the CSV file you uploaded. If your encoding selection doesn’t match the encoding of your file, your data might not import correctly. For example, characters not used in the standard Latin-script alphabet might be imported as symbols or special characters (!@#$%^&\*) might not be rendered correctly. [block:image] { "images": [ { "image": [ "https://files.readme.io/298a4f5259429139db75c68050e6ba43caa805d9cb31296859e3ba7a32234b1a-image.png", null, "CSV file encoding" ], "align": "center", "caption": "CSV file encoding" } ] } [/block] > 💡 Tip > > Some applications allow you to select an encoding method when you save a file as a CSV. By default, Google Sheets files use UTF-8 encoding. Microsoft Excel 2014 and later version files also use ANSI encoding. Microsoft Excel 2013 and earlier version files use ANSI encoding. ## Specify an HTTP method Select the method of your call in the **HTTP Method** field. You’ll most frequently use **GET** for [DataTable calls](ref:datatable-apis) and **POST** for [**/webapi/** calls](ref:about#types-of-orange-logic-apis). [block:image] { "images": [ { "image": [ "https://files.readme.io/7ca36d61d77844b4a83fbc232ecf8f4d71ad22d804a84b6a3063620360b8bfa2-image.png", null, "HTTP Method" ], "align": "center", "caption": "HTTP Method" } ] } [/block] ## Enter an API call Enter the API call in the **Template of API Call (Relative to the Base URL)** field. Omit the base URL. For example, if your base URL is ****, omit the base and enter the rest of the call, which usually begins with **/API/**. - If you’re running a DataTable call, the call must follow the [DataTable API syntax](ref:crud-operations-base-calls-and-syntax). [block:image]{"images":[{"image":["https://files.readme.io/ce2e00656571477480e459459b3005b10d3b78b26e27d9b7dafcef41455cece6-image.png",null,"A DataTable call in iAPI"],"align":"center","caption":"A DataTable call in iAPI"}]}[/block] - If you’re running a **/webapi/** or DataTable call with the **POST** method, enter the URL slug in the template field, and then enter the body of your call in the **Body** field, using JSON formatting. [block:image]{"images":[{"image":["https://files.readme.io/890fa26fb7e1b0b57073263b5158aa5211cb72c6662eb05b5bc9f4fc5e205115-image.png",null,"A /webapi/ call in iAPI"],"align":"center","caption":"A **/webapi/** call in iAPI"}]}[/block] > 💡 Tip > > You can copy the URL slug and build a JSON body in [Swagger](ref:api-testing#api-testing-tools) , and then paste both pieces of information in iAPI. ### Use placeholders In your call, replace specific object or metadata information with placeholders that reference the column headers in your CSV. > 💭 Example > > For example, you could use the following DataTable call structure to add tags to standard image assets: > > > /API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=**{identifier}**&CoreField.Keywords+=**{tags}** > > To run this call in an API client to update an individual asset, you would replace the information in curly brackets with actual data, like this: > > > /API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=**ZZ12PAR**&CoreField.Keywords+=**Seine river|Eiffel Tower|France** > > This call would update the asset with the identifier ZZ12PAR by adding the tags “Seine river,” “Eiffel Tower,” and “France.” > > To run this call in iAPI to update a set of assets you’ve identified in a CSV file, you would replace the information in curly brackets with placeholders that correspond to the column headers in your CSV file, like this: > > > /API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=**[Asset ID]**&CoreField.Keywords+=**[Tags]** > > This call would update every asset with an identifier in the “Asset ID” column of the selected CSV by adding the values in the “Tags” column of the same row. You can type your placeholders directly into your call. However, to ensure that what you enter matches your CSV file and is correctly recognized by iAPI, we recommend the following procedure: 1. Click **Get fields from file**. 2. Copy the column header shown in the **Headers in the CSV file** window. 3. Paste the column header into your call, including the square brackets. If the column name doesn’t appear in the **Headers in the CSV file** window, iAPI doesn’t recognize the header. [block:image] { "images": [ { "image": [ "https://files.readme.io/1417bc6e67ead68d24d306e9d57536dcb0a925f2c6cc3ae35194f3ca060e11dc-image.png", null, "Get fields from file" ], "align": "center", "caption": "Get fields from file" } ] } [/block] When you use iAPI for non-DataTable calls and use the POST, PUT, PATCH, or DELETE methods, you must use both the template and body fields. Enter the URL slug in the template field, and then enter the body of your call in the body field, using JSON formatting and using the column headers of your CSV file as placeholders. ## Configure log files You can change the location of the success and failure log files by entering a new path or clicking **Change location**. You can also update the names of these files if you have a preferred naming convention. These files can help you audit the changes that have been made or, when a call fails, help you understand what went wrong and troubleshoot the issue. [block:image] { "images": [ { "image": [ "https://files.readme.io/294d830cfe39e7c40c9fcbc006dec079184d375b976f2a4c1d7147fabbdb38ec-log_file_locations.png", null, "Log file locations" ], "align": "center", "caption": "Log file locations" } ] } [/block] When you run very large batches of calls (such as one million or more), the resulting success and failure log files will be lengthy. In this scenario, iAPI automatically splits the logs into multiple files limited to 75mb each. This behavior ensures you can open the files in Microsoft Excel or Windows Notepad and won’t exceed any file size limits. If your call logs require more than one success or failure log file, each file name is appended with a number. For example, you might have the following files: - Report 2026 Aug 14 \_Failure.csv - Report 2026 Aug 14 \_Failure_1.csv - Report 2026 Aug 14 \_Failure_2.csv - Report 2026 Aug 14 \_Success.csv - Report 2026 Aug 14 \_Success_1.csv - Report 2026 Aug 14 \_Success_2.csv ## Select a starting row Select which row in the CSV file you want the API call to start with by entering a row number in the **Start at Line Number** field. The first line of the CSV file is the header so, by default, the call starts with line 2. [block:image] { "images": [ { "image": [ "https://files.readme.io/113362e292c2a0972ff5627b3efa4e187385e7bbe0b01123c554f4c8ad16b16d-line_number.png", null, "Start at line number field" ], "align": "center", "caption": "Start at line number field" } ] } [/block] Use the starting line setting to [test your call](#run-a-call) on specific rows of data before you run the call on your entire CSV file. If the rows in your CSV file are significantly different (for example, if you have rows for different types of assets), use this setting to test each type of row and verify that data is processed as you expect in each unique circumstance. > 💡 Tip > > We recommend working with CSV files that are limited to a particular type of data. For example, you might want different files for different asset types or subtypes, or you might want different files for different parts of the folder hierarchy. This approach can minimize the risk of unintended changes. It also means you'll run many individual calls to process all the data spread across multiple files. > > Alternatively, you can work with a single large CSV file that collects all the data you need to update. This approach requires more thorough [testing](#run-a-call), but it also means you can start a single call and let it run unattended for a long period of time while it processes a large amount of data. ## Specify a number of threads Threads determine how many rows of data iAPI processes simultaneously. You can run up to four threads, meaning iAPI processes four rows of data at the same time. Increasing the number of threads can reduce processing time when you’re running a call on a large batch of data in your test environment. > ⚠️ Caution > > Using multiple threads can speed up the processing of your call, but it can also impact the performance of your Orange Logic environment, particularly if there are many active users. We recommend using multiple threads only in test environments. [block:image] { "images": [ { "image": [ "https://files.readme.io/aa0ee5727e2866a2d8fb0b1367e93754e013c80b0990bb3750916c71e925991f-Threads_field.png", null, "Threads field" ], "align": "center", "caption": "Threads field" } ] } [/block] > ℹ️ Note > > When you use multiple threads, the row numbers in success and failure logs might not be sequential. For example, when iAPI processes three rows at a time, row 7 might be processed before row 3. The logs still provide an accurate summary of which records were successfully processed and any issues that prevented processing. # Validate your configuration When your [configuration](#top) is complete, you can validate your setup. This step doesn’t guarantee that your call will be successful or that all your data will be correctly processed. Validation simply confirms that iAPI can correctly identify the objects you intend to update. - Click **Validate next record** to validate a single row in the CSV. iAPI starts with [the row you specify](#select-a-starting-row) and moves to the next row each time you click this button. - Click **Validate all records** to validate every row in the CSV. iAPI shows the number of records successfully identified. [block:image] { "images": [ { "image": [ "https://files.readme.io/bc4061b6ebb27e2780fde219ce4e6aef2ce27fe87bcb6fddcdde27f6a32a4095-Validate_records_-_update.png", null, "Validating records advances the start line and shows how many records were successfully identified" ], "align": "center", "caption": "Validating records advances the start line and shows how many records were successfully identified" } ] } [/block] # Run a call You have several options to start running a call: - **Process all records**: Run the call and process all the data in the CSV file. - **Process next record**: Run the call on a single row of data in the CSV file. iAPI starts with [the row you specify](#select-a-starting-row) and moves to the next row each time you click this button. Use this option to verify your configuration before running the call on all of your data. - **Test next record**: Run the call on a single row of data in the CSV file. The changes are immediately rolled back. Use this option to identify any errors without making any changes in your Orange Logic environment. We highly recommend you thoroughly test your calls. Always test at least one record before processing a whole CSV file. [block:image] { "images": [ { "image": [ "https://files.readme.io/823ee145843b2807f53376783422f00b6e76dfaf3fbf6e87b130c04b1ab8c9af-Run_a_call.png", null, "Run a call in iAPI" ], "align": "center", "caption": "Run a call in iAPI" } ] } [/block] # Review the status of a call Details of a call being processed appear at the bottom of the iAPI window. - **Last Call**: The URL of the call currently being processed. You can copy the call and run it directly in your web browser to see details, including values populated and error messages. - **Results For Last Call**: The response to the call most recently processed. You can copy and paste this content into a text document to easily search for errors. [block:image] { "images": [ { "image": [ "https://files.readme.io/20760682b7a684e3714c810aa4a084b5fb3cc5df6e4dbcd27b11bd490d243448-Successful_Current_Process.png", null, "Successful call details in iAPI" ], "align": "center", "border": true, "caption": "Successful call details in iAPI" } ] } [/block] The bottom of the iAPI window also shows the following information: - **Line being processed**: The row of the CSV file that is currently being processed. - **Total processed**: The number of rows that have been processed by the current call. - **Total lines in CSV**: The total number of rows that need to be processed by the current call. - **Success**: The number of rows that were successfully processed. - **Failure**: The number of rows that failed to process. - **Records processed per hour**: The average number of database objects processed per hour by the current call. - **Estimated time remaining**: The approximate time it will take the current call to finish running.