Systems and methods for software integration validation

Patent metadata

Field	Value
Publication number	US-11119906-B1
Application number	US-202016899037-A
Country	US
Kind code	B1
Filing date	Jun 11, 2020
Priority date	Jun 11, 2020
Publication date	Sep 14, 2021
Grant date	Sep 14, 2021

Abstract

A method and apparatus for providing a document-integrated software integration validation by a service provider system are described. The method includes serving an interactive integration guide user interface (UI) to a user system that displays information for an application programming interface (API) integration test scenario. The method also includes tracking, based at least in part on user system identifier, a sequence of one or more API calls of the user system following the initial API call, where the sequence corresponds to one or more stages of the API integration test scenario. Then, based on a determination of correctness from the tracking, the method includes serving an updated interactive integration guide UI to the user system indicating each operation in the API integration test scenario that was performed correctly and indicating each operation in the API integration test scenario that was not performed correctly.

First claim

We claim:

1. A method for providing a document-integrated software integration validation by a service provider system comprising:
serving, by a service provider system, an interactive integration guide user interface (UI) to a user system, the interactive integration guide UI displaying information for an application programming interface (API) integration test scenario;
detecting, by the service provider system, an initial API call generated by the user system, the initial API call including a test scenario identifier of the API integration test scenario, an integration guide identifier of the interactive integration guide UI served to the user system, and a user system identifier (ID);
tracking, by the service provider system based at least in part on the user system ID, a sequence of one or more API calls of the user system including the initial API call, one or more subsequent API calls of the user system, one or more API responses of the service provider system, or a combination thereof following the initial API call, where the tracked sequence corresponds to one or more stages of the API integration test scenario, wherein the initial API call and the one or more subsequent API calls of the user system are generated by a software application, which integrates services of the service provider system using one or more APIs of the service provider system, being developed by the user system;
determining whether the initial API call, the sequence of one or more API calls, the one or more subsequence API calls, the one or more API responses, or the combination thereof in the tracked sequence were performed correctly for the one or more stages of the API integration test scenario identified by the test scenario identifier; and
serving, by the service provider system, an updated interactive integration guide UI to the user system indicating each operation in the API integration test scenario that was performed correctly and indicating each operation in the API integration test scenario that was not performed correctly.

2. The method of claim 1 further comprising:
receiving, by the service provider system, login credentials from a user system purported to be associated with a user system account maintained by the service provider system;
in response to verifying the received login credentials with previously established login credentials associated with the user system account, logging in the user system associated with the user system account to the service provider system; and
the serving, by the service provider system, the updated interactive integration guide UI to the user system further comprises serving the updated interactive integration guide UI to the logged in user system associated with the user account.

3. The method of claim 1 , wherein the service provider system comprises a commerce platform system that provides payment processing services to the user system via API based messaging provided by one or more commerce platform APIs.

4. The method of claim 3 , wherein:
the test scenario identifier comprises a unique test payment card number associated with the API integration test scenario,
the integration guide identifier comprises a unique metadata identifier rendered within an API call displayed in the interactive integration guide user interface served to the user system, and
the user system identifier comprises an API key generated by the commerce platform system for a user system account maintained by the commerce platform system.

5. The method of claim 1 , wherein the one or more API calls generated by the user system and the one or more API responses of the service provider system are tracked in real time by the service provider system, and the serving of the updated interactive integration guide UI to the user system is performed in response to a determination of a correctness of a final stage that concludes the one or more stages of the API integration test scenario based on the one or more API calls and/or the one or more API responses tracked for the final stage.

6. The method of claim 1 , wherein the one or more API calls generated by the user system and the one or more API responses of the service provider system are tracked in real time by the service provider system, and the serving of the updated interactive integration guide UI to the user system is performed periodically in response to a determination of a correctness of each stage of the one or more stages of the API integration test scenario based on the one or more API calls and/or the one or more API responses tracked for said each stage.

7. The method of claim 1 , wherein the service provider system stores an expected sequence of one or more API calls and/or one or more expected API responses associated with each stage of the one or more stages, and determining whether the API integration test scenario is performed correctly by the user system comprises:
comparing the expected sequence of one or more API calls and/or the one or more expected API responses with the initial API call, the one or more subsequent API calls, the one or more API responses, or the combination thereof in the tracked sequence.

8. A non-transitory computer readable storage medium including instructions that, when executed by a processor, cause the processor to perform a method for providing a document-integrated software integration validation by a service provider system, the method comprising:
serving, by the service provider system, an interactive integration guide user interface (UI) to a user system, the interactive integration guide UI displaying information for an application programming interface (API) integration test scenario;
detecting, by the service provider system, an initial API call generated by the user system, the initial API call including a test scenario identifier of the API integration test scenario, an integration guide identifier of the interactive integration guide UI served to the user system, and a user system identifier (ID);
tracking, by the service provider system based at least in part on the user system ID, a sequence of one or more API calls of the user system including the initial API call, one or more subsequent API calls of the user system, one or more API responses of the service provider system, or a combination thereof following the initial API call, where the tracked sequence corresponds to one or more stages of the API integration test scenario, wherein the initial API call and the one or more subsequent API calls of the user system are generated by a software application, which integrates services of the service provider system using one or more APIs of the service provider system, being developed by the user system;
determining whether the initial API call, the sequence of one or more API calls, the one or more subsequence API calls, the one or more API responses, or the combination thereof in the tracked sequence were performed correctly for the one or more stages of the API integration test scenario identified by the test scenario identifier; and
serving, by the service provider system, an updated interactive integration guide UI to the user system indicating each operation in the API integration test scenario that was performed correctly and indicating each operation in the API integration test scenario that was not performed correctly.

9. The non-transitory computer readable storage medium of claim 8 , wherein the method further comprising:
receiving, by the service provider system, login credentials from a user system purported to be associated with a user system account maintained by the service provider system;
in response to verifying the received login credentials with previously established login credentials associated wi

Assignees

• Stripe Inc

Inventors

• Edouard Steven
• Qin Andrew
• Kavanaugh Erin
• Kosas Karolis

Classifications

• G06F11/3698

  Environments for analysis, debugging or testing of software · CPC title

• G06F9/547

  Remote procedure calls [RPC]; Web services · CPC title

• H04L67/02

  based on web technology, e.g. hypertext transfer protocol [HTTP] · CPC title

• G06Q30/0185 Primary

  Product, service or business identity fraud · CPC title

• G06Q20/3829

  involving key management · CPC title