Versions Compared

Old Version 6

changes.mady.by.user Danil Trefilov

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 tests. 
    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 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.

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

3. 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.

Image Removed

4. 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.

Image Removed

5. 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

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

Panel
  • Example of task: Image Removed
  • Attach to task created private key (test_key) and request for SSL certificate (request_csr).
    Check “Bin” (OpenSSL) folder for those files.

7. 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)

8. 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

Image Removed

  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

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
  • Mozilla Firefox: Menu → Preferences → Advanced → ViewCertificates → Your Certificates → Import → Choose created key store file (*.p12) on previous step;
  • 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

Step 4: Running your tests

  1. Check current versions available at test environment above
  2. Check API documentation
  3. Basic scenario
  4. 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) 
  5. No time limits for testing
  6. 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