Versions Compared

Old Version 3

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

Saved on

compared with

New Version Current

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 testsRunning test scripts. 
    Test the S7 Agent API to prevent future problems
  5. Signing of the contract of EDS. 
    Sign the contract electronically
  6. Accessing the production area.
    Complete integration and use the capabilities of the S7 Agent API 7 days after completing the application

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 (question) link to emails? vm@s7.ru
  2. Fill the application from with link to your portal
  3. S7 checks your form and initiate registration in our systems, include JIRA for communication with our technical support

Step 2: Access to the test environment. 

1. Check your environment for OpenSSL and install additional software

OpenSSL is required to create an SSL certificate

  • For GNU/Linux
Code Block
sudo apt install openssl
  • For MacOS
    No action is required — already included in OS

2. Check your environment for JDK version 7 or 8 and install additional software

JDK includes keytool which is required to create an SSL certificate (question) Зачем? Это ведь не требуется для последних версий SoapUI

Download the last version of JDK at http://www.oracle.com/technetwork/java/javase/downloads/index.html and setup

2. Create an SSL certificate for the test environment and configure your software

3. Import certificate and check availability of actual API version.

Download and setup OpenSSL.
The last binary version for Windows/Solaris can be downloaded at:
https://www.openssl.org/community/binaries.html

For GNU/Linux:

  • Download and setup JDK version 7 or 8.
    To convert the certificate, use the keytool included in the JDK:

    http://www.oracle.com/technetwork/java/javase/downloads/index.html

    • Use command line (administrator) create private key and request on SSL certificate.

    Info
    titleCreate private key:

    openssl genrsa -out ${clientkey}.pem 2048

    Image Removed

    Info
    titleCreate request on SSL certificate

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

    Image Removed

    Select their name for ${clientkey}, ${clientcsr} .

    Enter information about:

    • 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
    (warning) Check “Bin” (OpenSSL) folder where there will be  the private key (test_key)  and request on SSL certificate (request_csr).(warning)
    1. Access to production environment
      Get access to the production environment and complete integration
    2. Maintenance
      Use the all of capabilities of the S7 Agent API and stay tuned for a new features!

    Choose your role

    RoleDescriptionTarget period
    Integratora developer, who creates a solution for agents and proceed integration with the S7 Agent API7 working days
    Agent with own solutionan agent, who creates own solution for yourself and proceed integration with the S7 Agent API7 working days
    Agent with Integrator's solutionan agent, who going to use solution to connect to S7 environment, provided by integrator 3 working days


    Environment

    Excerpt Include
    Submitting requests | S7 Agent API
    Submitting requests | S7 Agent API
    nopaneltrue

  • Send  to JIRA request on SSL certificate (request_csr)

  • Receive the certificate, personal login and password for basic authentication and test access parameters for requests

    • start the import.

    Info
    titleImport SSL certificate

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

    Image Removed
    (warning) Export Password – key for test.p12 (warning)

    Import to browser:
    Mozilla Firefox > Menu > Preferences > Advanced > ViewCertificates > Your Certificates > Import > Выберите ${client}.p12
    Google Chrome > Settings > Advanced Settings  > HTTPS/SSL > Import > Выберите ${client}.p12

    Conversion SSL certificate with use JDK - убрать

    Info
    titleConversion SSL certificate

    keytool  -importkeystore  -srckeystore ${client}.p12  -destkeystore ${client}.jks  -srcstoretype PKCS12  -deststoretype JKS  -deststorepass ${password}  -srcstorepass ${password}

    Image Removed
    Warning
    titleAttention

    deststorepass ${password}  and  srcstorepass ${password} should be identical.

    (warning) After the command we get the file — test.jks (warning)

    Step 3: Hello world! 

    1. Check current versions available at test environment above
    2. Use personal login and password for basic authentication and test access parameters for requests
    3. Create SOAP project

    Open —  SoapUI > File > Preferences > SSL Setting

    Specify the path to the file jks and choose «requires client authentication».
    1. Create request
    2. Set BA for request 
    3. Set SSL for request
    4. Set header for version
    5. Send — Hello world!

    Step 4: Running your test scripts.

    1. Check API documentation
    2. Basic scenario
    3. 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) 
    4. No time limits for testing
    5. Give us feedback through your manager or technical support by JIRA

    Step 5: Signing of the contract of EDS. 

    1. Ready to production environment? Notify your manager
    2. Катя?
    3. Check basic flow? Review? Prod monitoring?
    4. Create online new validator without transactions history?

    Step 6: Accessing the production area. 

    1. create new certificate for production ()
    2. send to JIRA
    3. recieve new BA and SSL and access parameters from support
    4. use headers for actual and tested version
    5. Try to use read operations to check your first bookings and tickets that they are ok
    6. If you do not still sure ask our technical support by JIRA
    InfoIf you still have any question, try to resolved it with FAQ, documentation or ask our technical support by JIRA or email at api.support@s7.ru