Application program interface endpoint monitoring

Patent metadata

Field	Value
Publication number	US-2017353375-A1
Application number	US-201615173129-A
Country	US
Kind code	A1
Filing date	Jun 3, 2016
Priority date	Jun 3, 2016
Publication date	Dec 7, 2017
Grant date	—

Abstract

A computer-implemented method to monitor application program interface (API) endpoints may include sending, over a network from a computing system, a test structure to an API endpoint. In some embodiments, the test structure may be configured based on the API endpoint. The method may further include receiving a first response over the network at the computing system from the API endpoint in response to sending the test structure and resending, over the network from the computing system, the test structure to the API endpoint. The method may further include receiving a second response at the computing system from the API endpoint in response to resending the test structure and comparing, at the computing system, the first response and the second response. The method may further include determining, at the computing system, a status of the API endpoint based on the comparison of the first response and the second response.

First claim

What is claimed is:

1 . A computer-implemented method to monitor application program interface (API) endpoints, the method comprising:
receiving, at a computing system, a test structure configured based on an API endpoint on a first server; sending, over a network from the computing system, the test structure to the API endpoint; receiving a first response over the network at the computing system from the API endpoint in response to sending the test structure; storing the first response in a database when the first response is not an error code; resending, over the network from the computing system, the test structure to the API endpoint; receiving a second response at the computing system from the API endpoint in response to resending the test structure; comparing, at the computing system, the first response and the second response; and determining, at the computing system, a status of the API endpoint is error when the first response differs from the second response.

2 . The method of claim 1 , wherein the error code is an hypertext transfer protocol (HTTP) error code.

3 . The method of claim 1 , wherein the test structure includes an authentication token previously provided by the API endpoint, the authentication token provided by the API endpoint in response to the API endpoint receiving authentication credentials.

4 . The method of claim 1 , further comprising automatically generating a workflow when the status of the API endpoint is error.

5 . The method of claim 1 , further comprising:
storing the second response in the database; resending, over the network from the computing system, the test structure to the API endpoint; receiving a third response from the API endpoint; comparing, at the computing system, the third response and the second response; and determining, at the computing system, the API endpoint has a status of error when the third response differs from the second response.

6 . The method of claim 5 , wherein the second response is stored in the database in response to receiving an indication that the second response indicates an non-error status of the API endpoint.

7 . The method of claim 1 , wherein the test structure is part of a test file received at the computing system, wherein the test file further includes a network address of the API endpoint and configuration data.

8 . The method of claim 7 , wherein the configuration data includes one or more of authentication credentials and repeat data.

9 . The method of claim 8 , further comprising: repeating steps at a frequency determined by the repeat data, the steps including:
sending the test structure to the API endpoint; receiving a third response from the API endpoint; when the first response is not an error code, comparing the third response to the first response; and determining the status of the API endpoint is error when the third response differs from the first response.

10 . At least one non-transitory computer readable media configured to store one or more instructions that when executed by the computing system performs the method of claim 1 .

11 . A system configured to determine a status of application program interface (API) endpoints, the system comprising:
a database configured to store a test structure configured based on an API endpoint and a first response received from the API endpoint in response to the API endpoint receiving the test structure; a communication unit configured to send the test structure to the API endpoint and to receive the first response and a second response from the API endpoint, the second response received in response to the API endpoint receiving the test structure; and a processor configured to:
direct the communication unit to send the test structure to the API endpoint after receiving the first response when the first response is not an error code,
compare the first response and the second response, and
determine a status of the API endpoint based on the comparison of the first response and the second response.

12 . The system of claim 11 , wherein the database further comprises a plurality of different test structures that include the test structure, wherein each of the test structures corresponds to a different computing environment that communicates with the API endpoint, wherein the processor is configured to determine the status of the API endpoint with respect to each of the computing environments.

13 . The system of claim 11 , wherein the database further comprises a plurality of different test structures that includes the test structure and a plurality of different first responses that include the first response, wherein each of the test structures corresponds to a different one of a plurality of API endpoints that include the API endpoint and each of the plurality of first responses corresponds to a different one of the plurality of API endpoints.

14 . The system of claim 13 , wherein:
the communication unit is further configured to receive a plurality of second responses that include the second response, each of the plurality of second responses received from one of the plurality of API endpoints, and the processor is further configured to determine the status of each of the plurality of API endpoints based on comparisons of a first response of the plurality of first responses and a corresponding second response of the plurality of second responses.

15 . The system of claim 13 , wherein the processor is further configured to receive configuration data and provide a notification of the status for each of the plurality of API endpoints based on the configuration data.

16 . The system of claim 15 , wherein the processor is configured to provide the notification of the status for each of the plurality of API endpoints for presentation on a single display.

17 . A computer-implemented method to monitor application program interface (API) endpoints, the method comprising:
sending, over a network from a computing system, a test structure to an API endpoint, the test structure configured based on the API endpoint; receiving a first response over the network at the computing system from the API endpoint in response to sending the test structure; resending, over the network from the computing system, the test structure to the API endpoint; receiving a second response at the computing system from the API endpoint in response to resending the test structure; comparing, at the computing system, the first response and the second response; and determining, at the computing system, a status of the API endpoint based on the comparison of the first response and the second response.

18 . The method of claim 17 , further comprising:
resending, over a network from the computing system, the test structure to the API endpoint; receiving a third response from the API endpoint; comparing, at the computing system, the third response and the second response; and determining, at the computing system, the API endpoint has a status of error when the third response differs from the second response.

19 . The method of claim 17 , further comprising:
repeating steps at a frequency determined by repeat data received at the computing system, the steps including:
sending the test structure to the API endpoint;
receiving a third response from the API endpoint;
when the first response is not an error code, comparing the third response to the first response; and
determining the status of the API endpoint is error when the third response differs from the fi

Assignees

• Ebay Inc

Inventors

• Paropkari Anuya
• Bhatt Shivam
• SHAH Hetang

Classifications

• H04L63/08

  for authentication of entities (cryptographic mechanisms or cryptographic arrangements for entity authentication H04L9/32) · CPC title

• H04L67/02

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

• H04L41/0803

  Configuration setting · CPC title

• H04L43/50 Primary

  Testing arrangements · CPC title

• H04L69/40

  for recovering from a failure of a protocol instance or entity, e.g. service redundancy protocols, protocol state redundancy or protocol service redirection (management of faults, events, alarms or notifications in data switching networks H04L41/06) · CPC title