Quick Start for Agents | S7 Agent API

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!

Role

RoleDescriptionTarget period
Agent with own solutionan agent, who creates own solution for yourself and proceed integration with the S7 Agent API7 working days

Step 1: Application for connection

1. Contact to manager of your region and request for an application form (sample) at vm@s7.ru or https://api4agent.s7.ru/

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

In the contact data of a technical specialist must be specified:

  • Technical specialist
  • Agent representative

3. S7 checks your form and initiates registration in our systems

4. Go to Service Desk and register by your email. Here you will open tasks in case of errors when using the S7 Agent API and receive feedback from technical support.

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


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

3. Create request for SSL certificate:

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 Service Desk

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

7. Import SSL certificate and create key store file:

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

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 Service Desk.

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 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 special user stories (3d agreement, S7 Profi, blockchain) that you are interested in

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

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 Service Desk 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 technical support and keep

(warning) Keep all conversation with our technical support and technologists only in comments at the issue
(warning) If you faced any problems, create a new issue in Service Desk 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

Step 5: Signing of the contract of EDS

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 Scenarios v0.52 S7 Agent API

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

Step 6: Access to 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 Service Desk
  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

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

5. (warning) If validator's stock has less than 10 blanks, you'll receive the error as a result of ticket issuing at the production environment
Ask your manager to increase the validator's stock

6. (warning) If Agent credentials has not been used for 60 days, you'll receive the error as a result of any non-search operation at the production environment
Contact via Service Desk with used Agent credentials to renew them