Connecting to Spectrum OnDemand Servers - Spectrum_OnDemand - addressing - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum OnDemand
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
Last updated
2024-11-25
Published on
2024-11-25T19:42:51.884318

Spectrum OnDemand has servers in three regions. Each region has a staging environment and a production environment. In case you are not sure of the region, use the Global URL.

Server URLs

Region Environment URL Description
Global Staging https://staging.spectrum.precisely.com Resolves to location closest to request generation.
Production https://spectrum.precisely.com
Americas Staging https://amer-staging.spectrum.precisely.com Resolves to AMER first then rolls over to next available regions
https://us-staging.spectrum.precisely.com Resolves to US only. No rollover
https://token-amer-staging.spectrum.precisely.com Token URL. Resolves to AMER first, then rolls over to next available regions. For more information, see Using Token Authentication.
https://token-us-staging.spectrum.precisely.com Token URL. Resolves to US only. No rollover
Production https://amer.spectrum.precisely.com Resolves to AMER first, then rolls over to next available region.
https://us.spectrum.precisely.com Resolves to US only, no rollover
https://token-amer.spectrum.precisely.com Token URL. Resolves to AMER first, then rolls over to next available region. For more information, see Using Token Authentication.
https://token-us.spectrum.precisely.com Token URL. Resolves to US only, no rollover.
Batch https://amer-batch.spectrum.precisely.com Production for Batch Processing, non real time for AMER region.
Micro Batch https://amer-microbatch.spectrum.precisely.com Production for Micro Batch for AMER region.
Europe Staging https://emea-staging.spectrum.precisely.com Resolves to EMEA first, then rolls over to next available region.
https://eu-staging.spectrum.precisely.com Resolves to EU only. No rollover
https://token-emea-staging.spectrum.precisely.com Token URL. Resolves to EMEA first, then rolls over to other regions. For more information, see Using Token Authentication
https://token-eu-staging.spectrum.precisely.com Token URL. Resolves to EU only, no rollover.
Production https://emea.spectrum.precisely.com Resolves to EMEA first, then rolls over to next available region.
https://eu.spectrum.precisely.com Resolves to EU only, no rollover.
https://token-emea.spectrum.precisely.com Token URL. Resolves to EMEA first, then rolls over to next available region. For more information, see Using Token Authentication.
https://token-eu.spectrum.precisely.com Token URL. Resolves to EU only, no rollover.
Micro Batch https://emea-microbatch.spectrum.precisely.com Production for Micro Batch for EMEA region.
Asia Pacific Staging https://apac-staging.spectrum.precisely.com Resolves to APAC first, then rolls over to next available region.
https://au-staging.spectrum.precisely.com Resolves to AU only, no rollover
https://token-apac-staging.spectrum.precisely.com Token URL. Resolves to APAC first, then rolls over to next available region. For more information, see Using Token Authentication.
https://token-au-staging.spectrum.precisely.com Token URL. Resolves to AU only, no rollover.
Production https://apac.spectrum.precisely.com Resolves to APAC first, then rolls over to next available region.
https://au.spectrum.precisely.com Resolves to AU only, no rollover.
https://token-apac.spectrum.precisely.com Token URL. Resolves to APAC first, then rolls over to next available region. For more information, see Using Token Authentication.
https://token-au.spectrum.precisely.com Token URL. Resolves to AU only, no rollover.

The Americas server is the only one that has USPS® Delivery Point Validation (DPV®) data installed on it, so you must use the Americas URL if you want to perform DPV processing. If the Americas server is unavailable, requests are rerouted to another region and DPV processing becomes unavailable.

Note: Previous versions of Spectrum OnDemand used different URLs. You should now use only the URLs listed in this table.

Staging and Production Environments

The staging environment uses the same hardware and software as our production environment. A new update of Spectrum OnDemand is applied to the staging environment first. This allows you to test the update before we deploy it to the production environment.

You can use your Spectrum OnDemand username and password for both staging and production environments.
Note: The staging environment is not covered by SLA of Spectrum OnDemand and may undergo downtime without notice.
Note: The staging and production environments incurs regular usage charges with the following exceptions:
  • WSDL and WADL queries

    The WSDL for a Spectrum OnDemand web service is:

    https://OnDemandServer/soap/service_name?wsdl

    For example,
    https://spectrum.precisely.com/soap/ValidateAddress?wsdl

    The WADL for a Spectrum OnDemand web service is:

    https://OnDemandServer/rest/service_name?_wadl

    For example,

    https://spectrum.precisely.com/rest/ValidateAddress?_wadl

  • Token generation endpoints

    https://TokenEndPoint/security/jwt?mins=Val

    For example,

    https://token-amer.spectrum.precisely.com/security/jwt?mins=4

  • CreateAddressingInstanceKey endpoints

    For example,

    https://OnDemandServer/rest/CreateAddressingInstanceKey/results.json

    https://OnDemandServer/rest/CreateAddressingInstanceKey/results.xml

    https://OnDemandServer/soap/CreateAddressingInstanceKey

Performance and Security Testing

Remember: You must notify and coordinate with Precisely technical support prior to performing the performance and security testing.

Use the staging environment to evaluate services, experiment with different parameters, and to perform testing (UAT, Sanity, and so on). You must perform your performance and security testing on the staging environment.

Use the production environment for final acceptance testing and calls. Use the production environment for all the business critical tasks. Do not use the production environment for evaluation or other testing.

Server IP Addresses

Use URLs in your code and security appliances. Our IP addresses change often as part of our effort to provide fast responses and handle failures within our environment. If you have a security policy that requires you to know Spectrum OnDemand IP addresses, contact your Spectrum OnDemand Account Manager for details about the Static IP Pool program.

If your company's systems cache Spectrum OnDemand DNS entries, the cache needs to honor the Time to Live (TTL) attribute returned from the DNS authority. Systems that ignore the TTL attribute and use the same IP address for a period of time will experience a connectivity error when trying to connect to an IP address that is no longer active.

HTTPS

Use HTTPS when calling Spectrum OnDemand so your communication is secure.

Supported TLS Security Protocol and Ciphers

Our endpoints support TLS1.2 for HTTPS with below ciphers:
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384

Certificate Updates

We update our certificates annually. In addition, we may update our certificates at any time without notice to address security vulnerabilities reasons.

Retry Requests

HTTPS is a stateless protocol that does not guarantee delivery, so you should include retry logic in your application. For example, here is a synchronous variation of the AWS Backoff Algorithm:

retries = 0
DO
    wait for (2^retries * 100) milliseconds

    status = Call Synchronous Web Service

    IF status = SUCCESS
        retry = false
    ELSE IF status = HTTP 500, 502, 503 or 504 error
        retry = true
    ELSE
        Some other error occurred, so stop calling the web service.
        retry = false
    END IF

    retries = retries + 1
WHILE (retry AND (retries < MAX_RETRIES))

Persistent Connections

Spectrum OnDemand does not honor HTTP keep-alive requests and will disconnect after the first request is processed. This prevents you from remaining connected to a server that has failed or is offline for maintenance.

Monitoring

Spectrum OnDemand has extensive internal and external monitoring to ensure that services are available, including monitoring from 20 different sites within the US alone. It is not necessary for you to perform your own "heartbeat" check to verify that Spectrum OnDemand services are available. If your business has a special need for monitoring, contact your Spectrum OnDemand Account Manager.