Page Comparison

...

1. Go to Admin > System Tables > Service Hosts
2. Open a new Service Host, and select "REST API" on the Host Type list. The form will update, changing some of the inputs available. The image above shows a sample of the data needed for the new Host.
3. If the API you're using requires specific HTTP headers, you can use the "Data Encoding" list to select some pre-set headers. You can customize them in the "Request Headers" box. Enter one complete header per line. If you modify the presets, they won't be changed if you select a different "Data Encoding" item. Clear the text box if you want to switch Encoding types to use different preset headers.
4. Enter the URL to the API that will process your data. The "*https://*" is optional, but our Service Hosts will only send requests over an encrypted connection. APIs that don't support encrypted connections are not supported and strongly discouraged.
5. To make the Host reusable, use only as much of the API URL as is necessary to establish the connection. For example, many APIs use path segments to indicate how a request should be routed:
   • *https://some-other-host.com/api*/customers/1234?*first_name=Jeff*&*last_name=Smith*
     could indicate the customers table, ID # 1234 should update first_name and last_name to the provided values.

   • *https://some-other-host.com/api*/order/add
     could mean that an Order needs to be generated. Perhaps this API requires a JSON data object instead of a query string that would look like:

     Code Block
     language js
     { "45-abc-67": 1000, "~staples": 400, "SD_NUMBER": [the Service Desk Number from PCR-360] }

     This may indicate 1,000 of part # 45-abc-67 and 400 of something that looks like "staples", and the ServiceDesk SD Number is needed.

   • Notice the only common part of the above examples is the URL entered in the sample image. Everything after "api/" changes depending on what kind of request you're making. Provide the minimum part of the URL you need. The part of the URL that changes will be set in the Escalation Sequences.
6. If your connection requires authentication, provide the Username and Password. The password will be securely encrypted in the database. Some APIs use a Key string that acts as authentication so you don't need a User/Pass pair. You may need to provide the key as a parameter in the Escalation Sequence, or include it in the Host URL input above. Address specific requirements with the API owner.
7. Some APIs may also require usage of a configuration file, version, or specific network port to establish connection and/or exchange data. Fill these in as needed.
8. When all information is complete, Save the Service Host. Note that you cannot change the "Host Type" of existing Service Hosts anymore. This is to avoid retaining or adding invalid data, or removing necessary data, for a given Host Type.

The Service Host is now ready for setting up Escalations.

...