Steps

  1. Application for connection
    All information required for connection — in one application
  2. Access to the test environment
    Get access to the test environment and integrate under the supervision of S7 technicians
  3. Hello world!
    Set your software and make your first request!
  4. Running your tests
    Test the S7 Agent API to prevent future problems
  5. Signing of the contract of EDS
    Sign the contract electronically
  6. Access to the production environment
    Get access to the production environment and complete integration.
  7. Maintenance
    Use the all of capabilities of the S7 Agent API and stay tuned for a new features!

Target period — 7 working days

Environment

Test

Production

Step 1: Application for connection

  1. Contact to manager for your region and request them for an application from at vm@s7.ru; (question) link to contacts/emails?

  2. Fill the application form with link to your portal and send to S7 manager;

  3. S7 checks your form and initiate registration in our systems, include JIRA for communication with our technical support;
  4. Receive JIRA account credentials from S7.

Step 2: Access to the test environment

1. Check your environment for OpenSSL and install additional software (required to create a request for SSL certificate):

Download the last binary version of OpenSSL at https://www.openssl.org/community/binaries.html and install software


sudo apt install openssl


No action is required — already included in OS


2. Use command line (as administrator) to create private key:


openssl genrsa -out ${clientkey}.pem 2048

You have to replace ${clientkey} into understandable name using your local naming policies.

3. Create request for SSL certificate:


openssl req -new -key ${clientkey}.pem -out ${clientcsr}.pem

Replace ${clientcsr} into used name on previous step;

You have to replace ${clientkey} and ${clientcsr} into understandable name using your local naming policies.

4. Fill details of request for SSL certificate:

Mandatory:

  • Country Name (2 letter code)
  • State or Province Name
  • Locality Name (eg, city)
  • Organization Name (eg, company)
  • Organizational Unit Name (eg, section)
  • Common Name (your name or server's hostname)

No need to specify:

  • A challenge password
  • An optional company name

5. Create a new task with request of SSL certificate (request_csr) by JIRA

Attach to task created request for SSL certificate (request_csr).
Check “Bin” (OpenSSL) folder for those files.

6. Receive credentials for test environment from our technical support:

  • a SSL certificate (*.crt file)
  • personal credentials for basic authentication (login and password)
  • test access parameters for requests (XML block Party)
  • test Client ID and Agent ID for testing shopping with 3D agreement

7. Import SSL certificate and create key store file:


openssl pkcs12 -export -in ${clientcert}.pem -inkey ${clientkey}.pem -out ${client}.p12 -name "${name}"

Export Password – password for key sore file which will be requested while importing into test software

Step 3: Hello world! 

1. If you using test software build in browser you have to import keys (or check your software's documentation):

Menu → Preferences → Advanced → ViewCertificates → Your Certificates → Import → Choose created key store file (*.p12) on previous step


Settings → Advanced Settings → HTTPS/SSL → Import → Choose created key store file (*.p12) on previous step.

2. For a better experience, we prefer to use SoapUI for testing:

Download the last binary version of SoapUI at https://www.soapui.org/downloads/soapui.html and install software

3. Open SoapUI and create a new SOAP project

  1. SoapUI → File → Preferences → New SOAP project
  2. Check available versions at test environment at the top of the page;
  3. Copy relevant WSDL URL;
  4. Past in form, fill a project name and press OK.

4. Assign created key store file for the project

  1. Project → Show project view → WS-Security Configurations → Keystores;
  2. Click on "+" (Adds a new Keystore to this configuration);
  3. Set a path to p12-file and input the password;

(warning) Do not use global settings (SoapUI → File → Preferences → SSL Setting) to save ability of using both of environments without any additional setting changes

5. Create new request and set basic authentication

  1. Open tab "Auth" under request textarea;
  2. Select "Authorization" = "Basic";
  3. Input Username and Password (your received them from our technical support on previous step);

(warning) You have to set it for all your request

6. Set assigned keystore

  1. Go to tab "TestRequest Properties" under projects tree;
  2. Select imported p12-file in "SSL Keystore" parameter;

You have to set it for all your request

7. Set endpoint of test environment in the top of request window

8. Fill request teaxarea by example below and send it!


9. If you have no results, try to check your connection to exclude the case of incorrect credentials before you contact to our technical support by JIRA.

  1. Import key store file into browser (see steps to set up browser above)
  2. Go to any URL from Environment section via browser

Step 4: Running your tests

1. Choose one of available versions at test environment at the top of the page; 

2. Use header's parameters for selected version (If the parameter is not defined, the last version will be used by default):

3. Read the API's documentation;

4. Try to execute the user story with the simplest flow and then other scenarios that you are interested with;

  • We use actual schedule for flights but you may feel free for create bookings and issue tickets (but some minor discrepancies between test and production are still exist);
  • No time limits for testing;

5. Give us feedback through your manager or our technical support by JIRA.

Step 5: Signing of the contract of EDS

  1. Ready to production environment? Notify your manager
  2. (question) Катя?
  3. (question) Check basic flow? Review? Prod monitoring?
  4. (question) 3D agreement? Client ID and Agent ID?
  5. Create online new validator without transactions history?

Step 6: Access to the production area

Create a new certificate for production environment (similar as for test environment but the new one — check Step 2 for more details):

  1. Create private key;
  2. Create request for SSL certificate;
  3. Fill details of request for SSL certificate;
  4. Create a new task with request of SSL certificate (request_csr) by JIRA;
  5. Receive credentials for production environment from our technical support:
    1. a SSL certificate (*.crt file);
    2. personal credentials for basic authentication (login and password);
    3. access parameters for requests (XML block Party);
    4. Client ID and Agent ID (only If you are entered into 3D agreement)
  6. Import SSL certificate and create key store file;

Step 7: Maintenance

  1. Choose one of available and tested versions at production environment at the top of the page; 
  2. Use header's parameters for tested selected version (If the parameter is not defined, the last version will be used by default):
  3. Try to use read operations to check your first bookings (read operation) and issued tickets (retrieveTicket operation) that they are ok. If you are still not sure, don't hesitate to reach out our technical support by JIRA.
  4. Don't forget to check:
    1. Release Notes for new versions of S7 Agent API;
    2. FAQ and for most common issues you can be faced with.


If you still have any question, try to resolve it with FAQ, documentation or ask our technical support by JIRA or email at api.support@s7.ru