Versions Compared

Old Version 6

changes.mady.by.user Danil Trefilov

Saved on

compared with

New Version 7

changes.mady.by.user Pavel A. Smirnov (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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. Accessing Access to the production area environment.
    Get access to the production environment and complete integration.
  7. Maintenance.
    Use the all of Complete integration and use the capabilities of the S7 Agent API 7 days after completing the applicationand stay tuned for a new features!

Target period — 7 working days

Anchor
environment
environment
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 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.  Receive JIRA account credentials from S7;2. Check your environment for OpenSSL and install additional software (required to create a request for SSL certificate):


Panel
titleFor Windows/Solaris

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


Code Block
titleFor GNU/Linux
sudo apt install openssl


Panel
titleFor MacOS

No action is required — already included in OS


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

Panel


Code Block
openssl genrsa -out ${clientkey}.pem 2048

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

43. Create request for SSL certificate:

Panel


Code Block
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.

54. Fill details of request for SSL certificate:

Panel

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

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

Panel
Example of task:

Image Modified

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

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

Panel
  • a SSL certificate (*.crt file)
  • personal credentials for basic authentication (login and password)
  • test access parameters for requests (XML block Party)

87. Import SSL certificate and create key store file:

Panel


Code Block
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):

Panel
titleFor Mozilla Firefox
:

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

;


Panel
titleFor Google Chrome
:

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:

Panel

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: SoapUI → File → Preferences → New SOAP project 

  1. Open SoapUI and create a new project: SOAP project

Open —  SoapUI > File > Preferences > SSL Setting

Specify the path to the file jks and choose «requires client authentication».

3. For better experience we prefer to use SoapUI for test:

3. For better experience we prefer to use SoapUI for test:

3. For better experience we prefer to use SoapUI for test:

3. For better experience we prefer to use SoapUI for test:

  1. Create request
  2. Set BA for request 
  3. Set SSL for request
  1. Set header for version
  2. Send — Hello world!
Import to browser:
Mozilla Firefox > Menu > Preferences > Advanced > ViewCertificates > Your Certificates > Import > Выберите ${client}.p12
Google Chrome > Settings > Advanced Settings  > HTTPS/SSL > Import > Выберите ${client}.p12

Panel
  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

Panel
  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

Panel
  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

Panel
  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!

Excerpt Include
Basic 1
Basic 1

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.

Panel
  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

  • Check current versions available at test environment above
  • Check API documentation

    • 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):
    Image Added

    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;

    Panel
    Basic scenario
    • 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. Check (question) Check basic flow? Review? Prod monitoring?
    4. Create online new validator without transactions history?

    Step 6:

     Accessing

     Access to the production area

    create

    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. test access parameters for requests (XML block Party);
    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):
      Image Added
    3. send to JIRA
    4. recieve new BA and SSL and access parameters from support
    5. use headers for actual and tested version
    6. Try to use read operations to check your first bookings (read operation) and issued tickets (retrieveTicket) that they are okIf . If you do are still not still sure ask our sure, don't hesitate to reach out our technical support by JIRA.
    7. 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.


    Info

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