Test XML/HTTP SIS Integrations

The curl tool is a command line tool for transferring data with URL syntax. You can use curl to test your XML/HTTP integrations.

Download curl

Follow these steps to download curl.

  1. Go to http://curl.haxx.se/ to download a binary curl distribution appropriate for your system. Make sure to select the download that supports SSL.
  2. Extract the download to a folder on your computer.
  3. Add the folder to your PATH environment variable so that you can call curl from anywhere.

Prepare your XML feed files

Create the IMS XML feed files you want to test with and place them in a folder somewhere on your computer.

Create an IMS integration

Create a flat file integration using the following steps.

  1. Log on to the server you want to test as an administrator.
  2. On the Administrator Panel, under Integrations, select Data Integration.
  3. Select Student Information System Integrations.
  4. Open the integration's menu, select Create Integration, and then select Snapshot Flat File.
  5. Provide the required information and configure the integration according to your testing needs. Make sure to& note the Shared Username and Shared Password.

POST the XML files to the endpoint on the server you want to test using curl

The endpoint changes depending on what type of object is in the feed file and whether it's a persist or delete.

You can see a list of the endpoints on the server on the Http Information page for your flat file integration (Administrator Panel > Building Blocks > Data Integration > Student Information System Integrations > Your integration's context menu > Http Information).

  1. Open a command prompt and go to the folder that has your test files in it.
  2. Run the following command:

    curl -k -w %{http_code} -H "Content-Type:text/xml"
    -u SHARED_USERNAME:SHARED_PASSWORD --data-binary @PATH_TO_TEST_FILE
    https://SERVER_NAME/webapps/bb-data-...LEARN/endpoint

  3. Replace SHARED_USERNAME with the shared user name. For example, 11492d41-b04b-4172-a945-5d012bea1bea.
  4. Replace SHARED_PASSWORD with the shared password. For example, password.
  5. Replace PATH_TO_TEST_FILE with the path the XML feed file you want to upload. For example, c:\xml\my_test_file.xml.
  6. Replace SERVER_NAME with the name of the domain server. For example, bit-asin91sp6-lnx.pd.local.

    This will POST the XML file to the server.

    The output will be 200, in which case it was successfully posted, or you will see an error message and the HTTP error code (such as 403, 500, and so on).

    The following is an example successful message:

    E:\apps\curl>curl -k -w %{http_code} -H "Content-Type:text/xml" -u 11492d41-b04b-4172-a945-5d012bea1bea:password --data-binary @test.xml
    https://jrieckenw2k8.bbbb.net/webapp...LEARN/endpoint