Page History

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

Roles

Anchor
environment environment

Environment

Integrator

Agent with Integrator's solution

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

sudo apt install openssl

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

openssl genrsa -out ${clientkey}.pem 2048

3. Create request for SSL certificate:

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

4. Fill in the details of the request for SSL certificate:

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

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

7. Import SSL certificate and create key store file:

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

Responsibility of Integrator

Agent do not issue a certificate for the test environment

Integrator

Agent with Integrator's solution

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

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

3. Open SoapUI and create a new SOAP project

4. Assign created key store file to the project

5. Create new request and set basic authentication

6. Set assigned keystore

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

8. Fill in the request textarea by an example described 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.

Responsibility of Integrator

All tests executes by a personal certificate of integrator

Integrator

Agent with Integrator's solution

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 oldest 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 in

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

6. Ready to production environment?

6.1. Check available scenarios and choose which you're going to use at production environment

6.2. Notify our technical support by JIRA for final testing under the supervision of our technologists

6.3. Proceed test scenarios and attach all created PNRs and ETK numbers as a comment at the issue

6.4. Assign the issue to the "tech_s7" and keep

 Keep all conversation with our technical support and technologists only in comments at the issue
 If you faced any problems, create a new issue in JIRA and link with the issue for final testing

6.5. Once all tests will be passed you can proceed to signing of the contract of EDS

Responsibility of Integrator

Because Agent is going to use an Integrator's solution, we immediately proceed to signing of the contract of EDS and skip final testing under the supervision of our technologists to grant access to production environment

Integrator

Agent with Integrator's solution

Responsibility of Agent

Agent will notify you once all the documents have been completed and he will be granted access to the production environment 

1. Contact with your account manager to sign a contract

2. Create a new validator (without transactions history) for our GDS to have ability to execute all basic shopping scenarios

3. If you are interesting in discounts for corporate client you have to enter into 3D agreement between Agent, S7 and corporate client

4. Once all the documents have been completed, your account manager will notify you when you can proceed to the production environment

Integrator

Agent with Integrator's solution

The integrator is not allowed access to the prod environment.
An integrator prepares an implementation for a specific agent.

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

Responsibility of Integrator

Notify Integrator once all the documents have been completed and you will be granted access to the production environment 

Integrator

Agent with Integrator's solution

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 default version will be executed):

3. Try to use read operations to check the correctness of your first bookings (read operation) and issued tickets (retrieveTicket operation)

4. Don't forget to check our updates!

Despite the fact that the integrator was developing solution, you are responsible for all mistakes at the production environment