Skip to main content

Connecting to server-to-server APIs

Environments

We have three environments available for our partners.

  • Sandbox - this is shared environment, available as demonstration. You can get access before signing a deal with us - product@sparados.comĀ to get access.
  • Beta - This is environment you're going to use during integration with our services.
  • Production - This is live environment.

Authorization

Our APIs are secured with Mutual TLS Authentication. You will need certificate signed by us in order to connect. To get a certificate please send us an Certificate Signing Request (CSR). We will sign it and return a valid certificate in a response.

CSR should have following structure:

For Sandbox

Field Example value
Common Name (CN)

V-SBX-Sparados-{CompanyName}


CompanyName should be replaced with name of your company.

Organization (O) Name of your company
Organizational Unit (OU) [UUID] corp_id sent by Sparados adminĀ 
Locality (L)
City where your organization is located
State/County/Region (ST) State/County where your organization is located
Country (C) Two-letter country code where organization is located (ISO 3166-1 alpha-2)
Email Address Email to be contacted in case of forced renewal of the change
Example CSR generation command for Sandbox

Remember to replace parameters and file names with your own data
Commas cannot be used in parameters
Minimum key length is RSA 2048

openssl req -new -newkey rsa:4096 -keyout companyName.key -out companyName.csr -nodes -subj '/C=US/ST=Florida/L=Miami/O=SomeCompany/OU=UUID/CN=V-SBX-Sparados-CompanyName/emailAddress=example@user.com'

For Beta/Production

You will need separate certificates for Beta and Production environments, however they can be generated in exactly the same way.

Field Example value
Common Name (CN)

V-Sparados-{CompanyName}


Company Name should be replaced with name of your company.

Organization (O) Name of your company
Organizational Unit (OU) [UUID] corp_id sent by Sparados admin
Locality (L) City where your organization is located
State/County/Region (ST) State/County where your organization is located
Country (C) Two-letter country code where organization is located (ISO 3166-1 alpha-2)
Email Address Email to be contacted in case of forced renewal
Example CSR generation command for Beta and Production

Remember to replace parameters and file names with your own data
Commas cannot be used in parameters
Minimum key length is RSA 2048

openssl req -new -newkey rsa:4096 -keyout companyName.key -out companyName.csr -nodes -subj '/C=US/ST=Florida/L=Miami/O=SomeCompany/OU=UUID/CN=V-Sparados-CompanyName/emailAddress=example@user.com'