Versions Compared

Old Version 14

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

Saved on

compared with

New Version 15

changes.mady.by.user Yulia Amelina

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. Access to the production 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

Anchor
environment
environment
Environment

Test

Production

Anchor
Step1
Step1
Step 1: Application for connection

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

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

  3. S7 checks your form and initiate initiates registration in our systems, include including JIRA for communication with our technical support;
  4. Receive JIRA account credentials from S7 and folllow follow steps for connection to JIRA.

Anchor
Step2
Step2
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):

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


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

3. Create request for SSL certificate:

Panel


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

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

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

4. Fill in the details of the 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

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

Panel

Attach to the 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:

Panel
  • 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:

Panel


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

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

Anchor
Step3
Step3
Step 3: Hello world! 

1. If you are 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

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 to 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 the projects tree;
  2. Select imported p12-file in "SSL Keystore" parameter;

You have to set it for all your requestrequests

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

8. Fill in the request teaxarea textarea by an example described below and send it!

Excerpt Include
OW + 1xADT + Transit + S7 | searchFlight operation
OW + 1xADT + Transit + S7 | searchFlight operation
nopaneltrue

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 the browser (see steps to set up browser above)
  2. Go to any URL from Environment section via browser

Anchor
Step4
Step4
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 within;

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

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

6. Ready to production environment? Notify our technical support by JIRA for final testing under the supervision of our technologists.

Anchor
Step5
Step5
Step 5: Signing of the contract of EDS

  1. Contact with your account manager to sign a contract
  2. Create new validator for our GDS
  3. If you 
  4. Ready to production environment? Notify your manager
  5. (question) Катя?
  6. (question) Check basic flow? Review? Prod monitoring?
  7. (question) 3D agreement? Client ID and Agent ID?
  8. Create online new validator without transactions history?

Anchor
Step6
Step6
Step 6: Access to

the production area

production environment

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 a request for SSL certificate;
  3. Fill in the details of the request for SSL certificate;
  4. Create a new task with the 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;

Anchor
Step7
Step7
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 the correctness of 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 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  for most common issues you can be faced with.


Info

If you still have any questionquestions, try to resolve it with FAQ, find an answer using our FAQ and documentation or ask our for technical support by JIRA or email at api.support@s7.ru